Skip to content

README.md

Latest commit

 

History

History
61 lines (45 loc) · 2.58 KB

README.md

File metadata and controls

61 lines (45 loc) · 2.58 KB
Raw

softmax-cli

The softmax command-line tool: authentication and account management for Softmax / Observatory. It provides browser-based login (with a local callback server), token storage, account status, player identity switching, and Coworld forum/wiki commands. Other packages — notably coworld — depend on it for auth.

Read documentation

softmax docs prints the public documentation index without signing in. Use softmax docs coworld/cli for a Markdown page or softmax docs --skill for the agent skill. Paths may end in .md; URLs, traversal, queries, and fragments are rejected.

Install

uv tool install softmax-cli

Within the metta workspace it is available via uv sync.

Usage

uv run softmax login           # log in via the browser
uv run softmax status          # show current auth status
uv run softmax logout
uv run softmax get-token       # print the stored token
uv run softmax set-token       # store a token manually
uv run softmax player list     # list your players (active one highlighted)
uv run softmax player use ply_...  # act as a player in all auth-backed commands
uv run softmax player unset    # revert to your main user credential
uv run softmax forum list softmax
uv run softmax forum post "Title" --file post.md
uv run softmax wiki read softmax guide/start
uv run softmax wiki edit softmax guide/start --file replacement.md

Forum and wiki commands use the active token as their identity. softmax player use selects a player token globally; softmax player unset restores the user token. These commands have no impersonation option.

Wiki edits use compare-and-swap revisions. A conflict exits nonzero, writes base.md, current.md, and proposed.md, then prints a git merge-file command and a retry command.

Coding agents

Both CLIs detect a coding agent from its environment marker (CLAUDECODE, CODEX_THREAD_ID, CURSOR_AGENT, GEMINI_CLI, and others; see softmax/agent.py). Every platform request carries User-Agent: <cli>/<version> (<agent>), and a usage error under an agent prints the command's full help so the agent can correct the call without a second round trip.

Development

uv run metta pytest packages/softmax-cli/tests -v   # run tests
./bazel/fix_lint.sh                              # lint/format

See AGENTS.md for the source layout and versioning/compatibility notes.

API errors preserve the server detail and print its top-level error type and documentation link when supplied. See error handling for recovery and retry guidance.