@dleangen/cage-cli
v0.1.8
Published
The CLI for scaffolding and managing CAGE-enabled projects.
Readme
@dleangen/cage-cli
The CLI for scaffolding and managing CAGE-enabled projects.
Usage
$ npm install -g @dleangen/cage-cli
$ cage COMMAND
running command...
$ cage (--version)
@dleangen/cage-cli/0.1.8 linux-x64 node-v24.18.0
$ cage --help [COMMAND]
USAGE
$ cage COMMAND
...Commands
cage compile [CHART]cage help [COMMAND]cage initcage pluginscage plugins add PLUGINcage plugins:inspect PLUGIN...cage plugins install PLUGINcage plugins link PATHcage plugins remove [PLUGIN]cage plugins resetcage plugins uninstall [PLUGIN]cage plugins unlink [PLUGIN]cage plugins updatecage report [PATH]cage statuscage update
cage compile [CHART]
Render a CAGE Chart into Claude Code surfaces
USAGE
$ cage compile [CHART] [--dry-run] [--global] [-v <value>]
ARGUMENTS
[CHART] [default: .] Path to chart directory (default: current directory)
FLAGS
-v, --values=<value> Path to values override file
--dry-run Show what would change without writing any files
--global Allow writing to ~/.claude/CLAUDE.md (required for global-claude-md target)
DESCRIPTION
Render a CAGE Chart into Claude Code surfaces
EXAMPLES
$ cage compile ./my-chart --global
$ cage compile ./my-chart --values ./my-values.yaml --global
$ cage compile ./my-chart --dry-runSee code: src/commands/compile.ts
cage help [COMMAND]
Display help for cage.
USAGE
$ cage help [COMMAND...] [-n]
ARGUMENTS
[COMMAND...] Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for cage.See code: @oclif/plugin-help
cage init
Seed a project with CAGE governance files
USAGE
$ cage init [-f] [--management]
FLAGS
-f, --force Overwrite AGENTS.md and CLAUDE.md unconditionally
--management Register the current directory as the CAGE management repo in ~/.cage/config.yaml
DESCRIPTION
Seed a project with CAGE governance files
EXAMPLES
$ cage initSee code: src/commands/init.ts
cage plugins
List installed plugins.
USAGE
$ cage plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ cage pluginsSee code: @oclif/plugin-plugins
cage plugins add PLUGIN
Installs a plugin into cage.
USAGE
$ cage plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into cage.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the CAGE_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the CAGE_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ cage plugins add
EXAMPLES
Install a plugin from npm registry.
$ cage plugins add myplugin
Install a plugin from a github url.
$ cage plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ cage plugins add someuser/someplugincage plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ cage plugins inspect PLUGIN...
ARGUMENTS
PLUGIN... [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ cage plugins inspect mypluginSee code: @oclif/plugin-plugins
cage plugins install PLUGIN
Installs a plugin into cage.
USAGE
$ cage plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into cage.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the CAGE_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the CAGE_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ cage plugins add
EXAMPLES
Install a plugin from npm registry.
$ cage plugins install myplugin
Install a plugin from a github url.
$ cage plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ cage plugins install someuser/somepluginSee code: @oclif/plugin-plugins
cage plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ cage plugins link PATH [-h] [--install] [-v]
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
--[no-]install Install dependencies after linking the plugin.
DESCRIPTION
Links a plugin into the CLI for development.
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLES
$ cage plugins link mypluginSee code: @oclif/plugin-plugins
cage plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ cage plugins remove [PLUGIN...] [-h] [-v]
ARGUMENTS
[PLUGIN...] plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ cage plugins unlink
$ cage plugins remove
EXAMPLES
$ cage plugins remove myplugincage plugins reset
Remove all user-installed and linked plugins.
USAGE
$ cage plugins reset [--hard] [--reinstall]
FLAGS
--hard Delete node_modules and package manager related files in addition to uninstalling plugins.
--reinstall Reinstall all plugins after uninstalling.See code: @oclif/plugin-plugins
cage plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ cage plugins uninstall [PLUGIN...] [-h] [-v]
ARGUMENTS
[PLUGIN...] plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ cage plugins unlink
$ cage plugins remove
EXAMPLES
$ cage plugins uninstall mypluginSee code: @oclif/plugin-plugins
cage plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ cage plugins unlink [PLUGIN...] [-h] [-v]
ARGUMENTS
[PLUGIN...] plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ cage plugins unlink
$ cage plugins remove
EXAMPLES
$ cage plugins unlink myplugincage plugins update
Update installed plugins.
USAGE
$ cage plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.See code: @oclif/plugin-plugins
cage report [PATH]
Report which CAGE behavior profiles loaded in the given context
USAGE
$ cage report [PATH]
ARGUMENTS
[PATH] [default: .] Working directory to inspect (default: current directory)
DESCRIPTION
Report which CAGE behavior profiles loaded in the given context
EXAMPLES
$ cage report
$ cage report ./my-projectSee code: src/commands/report.ts
cage status
Show open issues you have filed against the CAGE repos
USAGE
$ cage status
DESCRIPTION
Show open issues you have filed against the CAGE repos
EXAMPLES
$ cage statusSee code: src/commands/status.ts
cage update
Refresh CAGE governance files from @dleangen/cage-core
USAGE
$ cage update
DESCRIPTION
Refresh CAGE governance files from @dleangen/cage-core
EXAMPLES
$ cage updateSee code: src/commands/update.ts
