docs / commands / help

`arkyn --help`

Prints usage information for the CLI. Also shown for arkyn -h, and for arkyn run with no arguments at all.

Usage

bash

npx @arkyn/cli --help

Usage: arkyn <command> [flags]

Commands:
  init --agents   Create or update AGENTS.md in the current project, referencing
                  the AGENTS.md docs shipped by installed @arkyn/* packages.

Flags:
  -h, --help      Show this help message

Unknown commands

Running any command the CLI doesn't recognize prints Unknown command: <name> followed by the same help message above, and exits with code 1.

bash

$ npx @arkyn/cli foo
Unknown command: foo
Usage: arkyn <command> [flags]
...

Notes

See init --agents for the only command currently available.

Related in Commands

init --agents

On this page