Charming CLI

Build and manage personal apps hosted by Charming from a terminal or coding agent.

Install from source

The first public package has not been published yet. Until then:

git clone https://github.com/tambo-labs/charming-cli.git
cd charming-cli
bun install
bun run build
bun link
charming doctor

Remove the link with bun unlink.

First app

charming auth login --no-open
charming apps create examples/hello --dry-run
charming apps create examples/hello --yes

Commands write JSON results to stdout. Login instructions and JSON errors go to stderr. Run mutations with --dry-run first. Live deletions and signed-in creates require --yes.

Environment

• CHARMING_TOKEN: user-token override.
• CHARMING_BASE_URL: API origin override.
• XDG_CONFIG_HOME: config-directory override.

The CLI stores credentials in $XDG_CONFIG_HOME/charming/config.json, or ~/.config/charming/config.json, with user-only permissions.

Development

bun install
bun run openapi:gen
bun run check

openapi.json is a snapshot of the Charming OpenAPI contract. src/generated/operations.ts is generated from it with the pinned Hey API version. Do not edit the generated file.

An hourly GitHub workflow checks the live Charming OpenAPI document. When the contract changes, it updates the snapshot and generated catalog and opens a pull request. UPSTREAM.json records the source URL and contract digest.

Agent skill

The portable skill lives at skills/charming-cli/SKILL.md.

Contributing

See CONTRIBUTING.md. Report security issues as described in SECURITY.md.