kapi share

$ kapi share [location]

Share this project's rules, terms and decisions with the people who work on it, and read what they shared.

The rules reach as far as one of three rungs:

On this machine your rules, your assistants With your team a shared folder or git Managed on Bowrain a team queue, who kept what, the same screens in a browser

With no flags, share syncs through the place kapi.yaml names: it reads what the others shared, merges it here, and shares what was kept on this machine. A project that names no place prints the rungs, with the command that moves it up.

--via names the place and writes it into kapi.yaml, then syncs once:

kapi share --via git a ref of this repository, outside every branch kapi share --via folder <path> a folder every machine reaches kapi share --via s3 <url> an S3 bucket, s3://<bucket>/<prefix> kapi share --via bowrain <url> a Bowrain server (needs the kapi-bowrain plugin)

A folder with no kapi.yaml gets the one kapi init writes. Commit kapi.yaml so every checkout names the same place. --via bowrain runs the plugin's connect, which prints what it prints, so its output is not JSON under --json.

--status prints the rung and the last sync without syncing. --no-push, --files-only, --merged, --pr and --merger mean what they mean for kapi context sync, the spelling an assistant or a CI job uses.

It exits with status 5 when the shared place cannot be reached, and nothing changes here.

Commandshare

Groupwork

Watch it

share needs network access, an API key, or local system access, so it can’t run in the browser playground.See the guides for a recorded run, or try it locally with the installed CLI.

Flags

Flag	Type	Default	Description
--files-only	bool	false	write the project's rules files (AGENTS.md, CLAUDE.md) from this machine's context and do nothing else
--merged	string		a range of commits that reached the default branch, counted as a person's signal
--merger	string		who merged it (the last commit's committer when unset)
--no-push	bool	false	read what others shared and share nothing back
--pr	int	0	the pull request that merged the range (read from the commit subject when unset)
--project, -p	string		path to a kapi.yaml project recipe or its directory (auto-discovered from cwd if omitted)
--status	bool	false	print the rung and the last sync, without syncing
--via	string		the place to share through: git, folder <path>, s3 <url> or bowrain <url>

More examples

kapi share --via gitkapi share --via folder /Volumes/team/kapikapi share --status

← Back to the Command Reference