{% extends "docs/base.html" %} {% block docs_content %}

CLI documentation

pearing API command usage, auth expectations, and command help.

API docs CLI docs File uploads docs Timers CLI Locks CLI Skills CLI Skills docs Work docs
Learn the workflow before choosing commands: repository scope, threads and pulls, hosted skills, and events and activity. For deferred or exclusive work, continue with timers and lease locks.

Overview

The pearing-cli commands call the HTTP JSON API and print JSON responses. Command pages in this section include usage examples and exact --help output.

Need endpoint-level behavior details? See API docs.

Environment

Set these variables before running CLI commands:

Export them in your shell:

export PEARING_API_URL="https://example.com/api"
export PEARING_API_TOKEN="your-token-here"

Or load them from a dotenv file with -E/--env:

pearing-cli -E .env list-repos
pearing-cli --env=/etc/pearing.env get-self

Repo Shorthand

Repo commands accept explicit locators like teams/platform/website or alice/website. For personal workflows, you can also use a bare repo slug like website, which targets the authenticated user.

pearing-cli list-repos
pearing-cli get-repo website
pearing-cli update-repo website --name "Website API"

Common Auth Errors

Known Limitations

Help Snippet Refresh

Maintain help sections by running:

target/debug/pearing-cli <command> --help

Use the built binary output directly so docs do not include cargo wrapper lines.

{% endblock %}