{% extends "docs/base.html" %} {% block docs_content %}
pearing API command usage, auth expectations, and command help.
Set these variables before running CLI commands:
PEARING_API_URL points at API root (for example https://example.com/api).PEARING_API_TOKEN is your API token from /profile/tokens.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 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"
401 Unauthorized for missing/invalid API token.403 Forbidden for inactive/expired token, inactive user, or insufficient role/scope.pearing-cli delete-team is currently unsupported by the API and returns method-not-allowed.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.