Skip to main content

Command line tools for managing Codeer agents over the Codeer API.

Project description

codeer-cli

Standalone CLI for managing Codeer agents over the Codeer API.

User install

After the package is published to PyPI, install the CLI as an isolated command line tool:

uv tool install codeer-cli

Until the package is published, install directly from this repository:

uv tool install 'git+https://github.com/<org>/codeer-skills.git#subdirectory=codeer-cli'

Replace <org> with the GitHub organization or user that hosts this repository.

Verify that the command is available:

codeer --help

Credentials

The CLI expects credentials to be configured outside any skill workspace. Add a named profile, select it, then verify the setup:

codeer profile add work
codeer profile use work
codeer check

codeer profile add prompts for the API key without echoing it. The local project stores only the selected profile name in .codeer/profile; API keys remain in the user-level config file.

For a one-off shell session, you can also export an API key directly:

export CODEER_API_KEY=<admin-workspace-api-key>
codeer check

CODEER_API_BASE defaults to https://api.codeer.ai. Override it only for local, beta, or preview environments:

export CODEER_API_BASE=http://localhost:8000

The CLI intentionally does not read repo-root credential files or caller CWD .env, because those files are often visible to LLM workspace context. Do not paste the API key into agent chat or commit it to the repository.

Workspace and organization scope are inferred from the workspace API-key virtual user's profile. --workspace, --org, CODEER_WORKSPACE_ID, and CODEER_ORGANIZATION_ID are not used by the CLI.

Agent scope is optional and can be set as a non-secret environment variable:

CODEER_AGENT_ID=<agent-id>

Development install

Use an editable install while the CLI is changing quickly:

cd /path/to/codeer-skills/codeer-cli
uv tool install --editable .

Reinstall only when dependencies, entry points, or package metadata change:

uv tool install --reinstall --editable /path/to/codeer-skills/codeer-cli

Validate setup before API work:

codeer check

Output policy for coding agents

The CLI is optimized for Codex, Claude Code, Claude Cowork, and similar coding agents that keep command output in their LLM context. Default stdout is a compact lifecycle summary, not the full server payload.

Use this pattern during agent lifecycle work:

codeer agent list
codeer history list --agent <agent-id> --limit 50
codeer eval run --agent <agent-id> --evaluators <evaluator-id> --out .codeer/eval_run.json

Flags:

  • --full prints bounded extra detail for human inspection. It is still intended to be safe for LLM context.
  • --out <path> writes complete diagnostic artifacts to a local file. Use it for raw eval results, full conversation turns, full rubric matrices, and other data that can grow with cases, versions, or turns.

Avoid piping large raw JSON directly into agent chat. Prefer --out, then ask the coding agent to inspect targeted summaries, IDs, failing cases, or selected snippets from the saved file.

Context Object FAQ

Use Context Object FAQ entries to route high-value questions to a canonical KB file when semantic retrieval misses the right source. The FAQ target is a KB file's snapshot_object_id, shown by codeer kb files.

codeer kb files --kb-id <kb-id>
codeer kb faq-list --context-object-id <snapshot-object-id>
codeer kb faq-create --context-object-id <snapshot-object-id> --question "..." --dry-run

After reviewing the dry-run output, rerun the create/update/delete command without --dry-run to apply it.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

codeer_cli-0.1.1.tar.gz (56.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

codeer_cli-0.1.1-py3-none-any.whl (54.1 kB view details)

Uploaded Python 3

File details

Details for the file codeer_cli-0.1.1.tar.gz.

File metadata

  • Download URL: codeer_cli-0.1.1.tar.gz
  • Upload date:
  • Size: 56.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.5

File hashes

Hashes for codeer_cli-0.1.1.tar.gz
Algorithm Hash digest
SHA256 84fe68667fea86fb65084a45aa8be5fc095cff0609508873b73dbfbf654d24a1
MD5 fea0884544f957a791b3749c4e81cda2
BLAKE2b-256 ac6c96b0c589a3ae226233c498a5ad9c1c9cf7c16764f93998b3688ede9e21f1

See more details on using hashes here.

File details

Details for the file codeer_cli-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: codeer_cli-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 54.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.5

File hashes

Hashes for codeer_cli-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b601c00196891a87f0d1dd0eee23d11dd88e5f2861708c629889c80deb8d5972
MD5 b76af8aa50ac8e0eddcd409a75a1cc21
BLAKE2b-256 ea152cfb50583ee67ca74356e8d7689b9ba6b5a4e3a09248e53c8274534f1e6e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page