Skip to content

CLI

BeeWeave exposes the bwe command.

Core Commands

bwe setup             install skills into agents and write config
bwe profile           manage BeeWeave profile config files
bwe external          manage user-installed external agent skills
bwe uninstall         remove BeeWeave skills and config
bwe upgrade           upgrade BeeWeave and refresh installed skills
bwe list              list bundled skills
bwe info              show install paths, version, and config

Knowledge and Graph Helpers

bwe graph-query       query the vault wikilink index
bwe graph-analyse     analyze vault graph structure
bwe batch-plan        plan parallel ingest batches

Cache and Source Helpers

bwe cache-check       check source changes against .manifest.json
bwe cache-update      record source hashes after ingestion
bwe cache-hash        compute source hashes
bwe ast-extract       extract code structure without LLM calls

Setup Examples

bwe setup --agents claude,codex
bwe setup --global-extra beeweave-capture
bwe setup --profile work
bwe profile set-default work
bwe external install https://github.com/op7418/guizang-ppt-skill --skill guizang-ppt-skill --link-project .
bwe external list
bwe uninstall --all
bwe upgrade --check
bwe upgrade
bwe info

Run bwe setup from the workspace where you want runtime vault/ and workbench/ folders to be created.

By default, setup writes ~/.beeweave/config. Use --profile NAME to write a named profile at ~/.beeweave/config.NAME. Setup does not activate named profiles or repoint ~/.beeweave/config; use @name in agent requests to target a named profile. In interactive setup, choose new profile... to enter a new profile name without leaving setup.

Use bwe profile set-default NAME to intentionally copy ~/.beeweave/config.NAME to ~/.beeweave/config. If a default config already exists, BeeWeave creates a timestamped backup and requires YES before overwriting it.

Use bwe uninstall --all to also clean project-local BeeWeave files from workspaces referenced by all BeeWeave profile configs. Vault and workbench content is preserved.

External Skills

Use bwe external to manage third-party agent skills without vendoring those repositories into BeeWeave itself or into runtime vault/ and workbench/ folders.

External skills live under:

~/.beeweave/external/
+-- repos/       # cloned source repositories
+-- skills/      # stable skill-name entries
+-- manifest.json

Common commands:

bwe external install <source> --skill <name> --link-project .
bwe external link <skill-name> --project .
bwe external list
bwe external info <skill-name>
bwe external update [skill-name]
bwe external remove <skill-name>

<source> can be a GitHub URL, git URL, owner/repo shorthand, GitHub tree URL, or local path. Use --ref to install from a branch, tag, or commit.

For repositories containing more than one skill, choose exactly what to install:

bwe external install https://github.com/op7418/guizang-ppt-skill \
  --skill guizang-ppt-skill \
  --link-project .

bwe external install https://github.com/JimLiu/baoyu-skills \
  --skill baoyu-url-to-markdown

bwe external install https://github.com/JimLiu/baoyu-skills/tree/main/skills/baoyu-url-to-markdown

BeeWeave does not install every skill from a multi-skill repository unless --all is explicit. Use bwe external link <skill-name> --project <path> when you want to link an already installed external skill into another workspace.

Upgrade

Use bwe upgrade --check to compare the installed BeeWeave version with the latest package version without changing files.

Use bwe upgrade for the common upgrade workflow. BeeWeave detects supported install methods and upgrades with the matching installer:

uv tool upgrade beeweave
python -m pip install --upgrade beeweave

After a successful supported package upgrade, BeeWeave replays the setup choices recorded by prior successful bwe setup runs. This refreshes installed agent skill directories for all recorded profiles/workspaces so agents see the new bundled skills. If no setup replay state exists, run bwe setup once.

Unsupported or source-checkout installs are not mutated automatically; bwe upgrade prints conservative manual steps instead.