Skip to content

About

CLI tooling for better agentic development

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

suave

AI-powered CLI that sets up your project for AI-assisted coding — generates CLAUDE.md, AGENTS.md, and the config files that tools like Claude Code, Cursor, and Codex need from day one.


Before you start

You need two things installed on your machine:

1. Node.js (version 18 or newer)

Check if you already have it:

node --version

If the command is not found or the version is below 18, install Node.js from nodejs.org — download the LTS release and run the installer.

2. An Anthropic API key

suave calls Claude to generate your project files.

  1. Go to console.anthropic.com and create a free account.
  2. Open API Keys in the sidebar and click Create Key.
  3. Copy the key — it starts with sk-ant-.

Install

npm install -g @suavetech/cli

Verify it worked:

suave --version

First-time setup

Run suave setup once to save your API key so you don't have to enter it every time:

suave setup

It will prompt you for your Anthropic API key and save it to ~/.suave/config.json.


Create a new AI-ready project

suave create my-app

suave will ask you a few questions about your project, then call Claude and write:

File / folder What it's for
CLAUDE.md System prompt that Claude Code reads
AGENTS.md Agent guidance for Cursor, Codex, etc.
CHANGELOG.md Changelog scaffold
.claude/settings.json Claude Code permissions & settings
.agents/config.json Provider-agnostic agent config

If you answer yes to the TypeScript prompt, it also scaffolds a full TS project (package.json, tsconfig.json, biome.json, lefthook.yml, tsup.config.ts).

Just want placeholder files without calling the API?

suave create my-app --dry-run

Audit an existing project

Run this in any directory to see which agentic files are present:

suave audit
# or check a specific path
suave audit ./path/to/project

Exits with a non-zero code if any required file is missing — useful in CI.


All commands

Command Description
suave setup Save your API key and see available commands
suave create [name] Scaffold a new AI-ready project in a new directory
suave audit [path] Report which agentic files exist (default: .)

Global flags

Flag Description
--dry-run Show what would be written without writing anything
--yes, -y Skip all confirmation prompts
--verbose Print the meta-prompt and streamed LLM response

Configuration

To override the audit list or model for a specific project, create .suave/config.json in that project's root:

{
  "model": "claude-sonnet-4-6",
  "agenticFiles": [
    { "type": "file", "path": "CLAUDE.md",  "label": "Claude prompt", "required": true },
    { "type": "file", "path": "AGENTS.md",  "label": "Agent spec",    "required": true },
    { "type": "dir",  "path": ".cursor",    "label": "Cursor rules" }
  ]
}

Environment variables

Variable Description
ANTHROPIC_API_KEY Your Anthropic key (set by suave setup)
SUAVE_API_KEY Overrides ANTHROPIC_API_KEY if set

Development

pnpm install
pnpm dev          # watch build
pnpm build        # emit dist/index.js
pnpm start setup  # run the built CLI locally

Publishing a new version

pnpm release:patch   # 0.1.0 → 0.1.1  (bug fixes)
pnpm release:minor   # 0.1.0 → 0.2.0  (new features)
pnpm release:major   # 0.1.0 → 1.0.0  (breaking changes)

Each command builds, bumps the version, publishes to npm, and pushes the git tag.


License

MIT

About

CLI tooling for better agentic development

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages