<!-- generated by scripts/gen-reference.mjs; do not edit -->
CLI reference
Generated from the basics command tree.
basics
Personal tech-stack vault shared with coding agents
basics [options] [command]| Flag | Description | Default |
|---|---|---|
-V, --version | output the version number | — |
-v, --vault <dir> | vault directory (default: $BASICS_DIR, config "vault", or ~/basics-vault) | — |
basics config
read or change the global basics config
basics config [options] [command]No options.
basics config path
print the config file path
basics config path [options]No options.
basics config get
print the config and the resolved vault directory
basics config get [options]No options.
basics config set
set vault <dir>, language <en|es> or embeddings <true|false>
basics config set [options] <key> <value>No options.
basics embeddings
opt-in local embeddings and vector index
basics embeddings [options] [command]No options.
basics embeddings enable
download the runtime and model, then index the vault
basics embeddings enable [options]| Flag | Description | Default |
|---|---|---|
--yes | skip the download confirmation | — |
basics embeddings disable
turn embeddings off (keeps the downloaded files)
basics embeddings disable [options]| Flag | Description | Default |
|---|---|---|
--purge | also delete the runtime and model cache | — |
basics embeddings status
show config, runtime, model cache and index state
basics embeddings status [options]No options.
basics embeddings reindex
sync the vector index with the current vault
basics embeddings reindex [options]| Flag | Description | Default |
|---|---|---|
--full | re-embed every note | — |
basics doctor
check Node, config, vault, packs and embeddings
basics doctor [options]| Flag | Description | Default |
|---|---|---|
--fix | apply the fixes doctor knows how to make | — |
--json | print the checks as JSON | — |
basics init
create a vault and install note packs
basics init [options] [dir]| Flag | Description | Default |
|---|---|---|
--lang <lang> | note language (en|es) | — |
--packs <names> | comma-separated pack names, or none | — |
--yes | accept defaults and install all packs | — |
basics connect
register the Basics MCP server and skill with your coding agents
basics connect [options]| Flag | Description | Default |
|---|---|---|
--client <names...> | clients to register (claude-code, opencode, codex, cursor, claude-desktop); default: every client detected | — |
--transport <transport> | stdio or http | stdio |
--port <n> | port for the http transport | 4747 |
--no-skill | do not install the Basics skill | — |
--dry-run | print every change without writing anything | — |
basics pack
manage official and community note packs
basics pack [options] [command]No options.
basics pack list
list packs and installed versions
basics pack list [options]No options.
basics pack install
install packs and their requirements
basics pack install [options] <names...>| Flag | Description | Default |
|---|---|---|
--lang <lang> | note language (en|es) | — |
basics pack add
add a community pack from GitHub; notes land in the inbox for review
basics pack add [options] <ownerRepo>| Flag | Description | Default |
|---|---|---|
--path <subdir> | subdirectory within the repo that holds the pack | — |
--lang <lang> | note language (en|es) | — |
basics pack update
propose pack updates for review in the inbox
basics pack update [options] [name]No options.
basics pack remove
remove a community pack from the cache (installed notes stay)
basics pack remove [options] <ownerRepo>No options.
basics list
list notes, grouped by layer for tech notes
basics list [options]| Flag | Description | Default |
|---|---|---|
-t, --type <type> | filter by type (layer|tech|practice|check|profile|project) | — |
basics validate
check frontmatter schemas, duplicate ids and broken links
basics validate [options]No options.
basics search
full-text search over the vault
basics search [options] <query...>No options.
basics recommend
shortlist technologies per layer for a project description
basics recommend [options] <description...>| Flag | Description | Default |
|---|---|---|
--json | print the full JSON response | — |
basics new
create a note from a template
basics new [options] <type> <id>| Flag | Description | Default |
|---|---|---|
-l, --layer <layer> | layer for tech notes | backend |
basics inbox
review agent proposals
basics inbox [options] [command]No options.
basics inbox list
basics inbox list [options]No options.
basics inbox show
basics inbox show [options] <id>No options.
basics inbox approve
basics inbox approve [options] <id>No options.
basics inbox approve-all
approve pending proposals (all, or only a pack/version/agent)
basics inbox approve-all [options]| Flag | Description | Default |
|---|---|---|
--pack <name> | pack name, e.g. python-api | — |
--version <version> | only proposals from this pack version | — |
--agent <name> | only proposals from this agent | — |
basics inbox reject
basics inbox reject [options] <id>No options.
basics inbox reject-all
reject pending proposals (all, or only a pack/version/agent)
basics inbox reject-all [options]| Flag | Description | Default |
|---|---|---|
--pack <name> | pack name, e.g. python-api | — |
--version <version> | only proposals from this pack version | — |
--agent <name> | only proposals from this agent | — |
basics ui
start the local web UI and HTTP API
basics ui [options]| Flag | Description | Default |
|---|---|---|
-p, --port <n> | port to listen on | 4747 |
--no-open | do not open the browser | — |
basics export
write STACK.md plus agent instructions (AGENTS.md, CLAUDE.md, Cursor rules) for a project
basics export [options] [dir]| Flag | Description | Default |
|---|---|---|
-s, --stack <ids> | comma-separated tech ids, e.g. fastapi,react,playwright | — |
-t, --targets <names> | comma-separated targets (agents,claude,cursor) | — |
--detect | detect the stack from package.json, pyproject.toml and requirements files | — |
--templates | write check file templates that do not exist yet | — |
--dry-run | print each file and whether it would change, without writing | — |
basics check
run the stack checks of a project, trusting each command first
basics check [options] [dir]| Flag | Description | Default |
|---|---|---|
--only <ids> | comma-separated check ids to run | — |
--list | list checks, commands and trust state without running | — |
--trust | trust and run every check without asking | — |
--timeout <s> | per-check timeout in seconds | 600 |
--verbose | stream command output | — |
--strict | fail on skipped or untrusted checks too | — |
basics detect
detect technologies and versions from a project's manifests
basics detect [options] [dir]| Flag | Description | Default |
|---|---|---|
--json | print the full detection result as JSON | — |
basics init-project
deprecated: use basics export --targets agents
basics init-project [options] [dir]| Flag | Description | Default |
|---|---|---|
-s, --stack <ids> | comma-separated tech ids, e.g. fastapi,react,playwright | — |
--dry-run | print each file and whether it would change, without writing | — |