Skip to main content

shushu CLI

Project description

shushu

Agent-first per-OS-user secrets manager CLI. Part of the AgentCulture ecosystem; sibling to zehut (identity layer) and patterned on afi-cli (noun-verb shape, exit-code discipline, structured --json output).

Each OS user gets their own secrets store at ~/.local/share/shushu/secrets.json (mode 0600, owned by the user). shushu never reaches across users in self-mode. Admin handoff to another user goes through a single setuid-fork chokepoint and preserves the H2 hidden-secret contract — admin can never extract a value through any CLI verb.

Install

uv tool install shushu
shushu --version

Linux only (uses setuid / useradd semantics). Python ≥ 3.12.

Quick start

# store a secret you already have (stdin form preferred — keeps the
# value out of /proc/<pid>/cmdline and shell history)
echo -n "sk-..." | shushu set OPENAI_API_KEY -

# generate a random one, hidden — never printed
shushu generate JWT_SECRET --bytes 32 --hidden

# inspect (never prints value)
shushu show OPENAI_API_KEY
shushu show OPENAI_API_KEY --json

# consume — visible secrets only
shushu get OPENAI_API_KEY
eval $(shushu env OPENAI_API_KEY DATABASE_URL)

# consume — visible OR hidden (this is the only path for hidden)
shushu run --inject JWT=JWT_SECRET --inject DB=DATABASE_URL -- ./myapp

shushu list and shushu overview give names and metadata. shushu delete NAME removes a record.

Self-teaching surface

shushu learn                # markdown summary of every verb + concept
shushu learn --json         # structured payload for agent consumers
shushu explain hidden       # explain a concept
shushu explain set          # explain a verb

Admin handoff

shushu is single-admin-trusted-host. Admin operations go through sudo; the binary forks → drops to the target user → writes/reads under their uid. Every admin write stamps source = "admin:<invoker>" and handed_over_by = "<invoker>" so the receiving user can audit.

# provision a secret into alice's store as root
sudo shushu set --user alice OPENAI_API_KEY -

# read-only audit across every user with a shushu store
sudo shushu overview --all-users
sudo shushu doctor --all-users

# delete a record from alice's store
sudo shushu delete --user alice OPENAI_API_KEY

get, env, run deliberately have NO admin flags — values are never extractable through the CLI, even for root. Use sudo cat ~alice/.local/share/shushu/secrets.json if you truly need plaintext (at which point you've moved outside shushu's contract).

Hidden secrets — the H2 contract

A secret with hidden: true:

  • Is immutable post-create — you cannot toggle the hidden flag.
  • Is refused by get, env, show (they exit 64 with a remediation pointing at run --inject).
  • Has its value omitted from generate --hidden --json output (the JSON payload has no value field).
  • Is consumable only through shushu run --inject VAR=NAME -- cmd.

Hidden is a CLI contract, not encryption. The on-disk file is plaintext at 0600. Encryption-at-rest is tracked for a future v1.x release in issue #8.

Exit codes

Code Meaning
0 success
64 bad input from the caller (invalid flag, missing record, hidden refusal, etc.)
65 store is corrupt / schema mismatch / unreadable
66 this operation requires root
67 backend dependency failed (unknown OS user, etc.)
70 bug in shushu — please file an issue

Every error path emits a structured ShushuError with a remediation string. With --json, errors land as {"ok": false, "error": {...}} on stdout (single-payload contract).

Docs

Development

git clone https://github.com/agentculture/shushu
cd shushu
uv sync                                                         # install deps
bash .claude/skills/run-tests/scripts/test.sh -p                # unit suite
bash .claude/skills/run-tests/scripts/test.sh --ci              # CI parity

Integration tests need real root + useradd/userdel, which we only do inside a disposable Docker image:

docker build -f .github/workflows/Dockerfile.integration -t shushu-int .
docker run --rm -e SHUSHU_DOCKER=1 shushu-int uv run pytest tests/integration -v

See docs/testing.md for the broader test-isolation conventions and the smoke-test namespace under /tmp/shushu-tests/.

License

MIT. © 2026 Ori Nachum / AgentCulture.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shushu-0.8.0.tar.gz (136.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

shushu-0.8.0-py3-none-any.whl (35.8 kB view details)

Uploaded Python 3

File details

Details for the file shushu-0.8.0.tar.gz.

File metadata

  • Download URL: shushu-0.8.0.tar.gz
  • Upload date:
  • Size: 136.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for shushu-0.8.0.tar.gz
Algorithm Hash digest
SHA256 237251718d5404003db7329f0f6557c0c935df33830dfc9e7e0ed6e4157ffd55
MD5 89e3e47e3c30d0fad432a168bacf3e25
BLAKE2b-256 5d23b33ee28ba44147c6e61bd129c91a376be0a9c3f0e53981fb07f53f348b8c

See more details on using hashes here.

Provenance

The following attestation bundles were made for shushu-0.8.0.tar.gz:

Publisher: publish.yml on agentculture/shushu

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file shushu-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: shushu-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 35.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for shushu-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5d2cd79e9ad33112194203d4cdc97ebf09f5b129ab87bb771fb02e6661e73fd2
MD5 06f40cb497d3414ccc9c09a50dba4dd0
BLAKE2b-256 1b39f9922ff5a4e14d50f89d86e154209852ebb53ca9c371c2ee22a28bb7048a

See more details on using hashes here.

Provenance

The following attestation bundles were made for shushu-0.8.0-py3-none-any.whl:

Publisher: publish.yml on agentculture/shushu

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page