--json as a global flag. JSON mode is the preferred interface for agents because successful commands return { "ok": true, "type": "...", "data": ... } and failures return { "ok": false, "error": ... }.
Store Commands
| Command | Purpose | Arguments | Flags |
|---|---|---|---|
glyph install | Copy the running binary into the user bin directory and add that directory to PATH for new terminals. | None | --bin-dir |
glyph version | Print build version, commit, and build date. | None | None |
glyph check <realm> | Materialize a realm export and run configured export checks. | realm | --check, --keep, --out |
glyph init | Initialize .glyph/ in the current project. | None | None |
glyph import <path> | Import files from a workspace path into the public source graph. | path: directory to import | None |
glyph status | Show store status, database path, and object counts. | None | None |
glyph graph | Show source graph summary. | None | None |
Auth Commands
| Command | Purpose | Arguments | Flags |
|---|---|---|---|
glyph auth login <server-url> | Store a Glyph server token locally. | server-url | --token |
glyph auth status | List servers with stored credentials. | None | None |
glyph auth logout <server-url> | Remove a stored Glyph server token. | server-url | None |
Work Commands
| Command | Purpose | Arguments | Flags |
|---|---|---|---|
glyph work start <name> | Create a work context from a realm projection. | name | --from <realm> defaults to public |
glyph work list | List work contexts. | None | None |
glyph work status <name> | Show one work context. | name | None |
glyph work snapshot <name> | Create a manual snapshot for a work context. | name | None |
glyph work claim <name> | Claim a work context for a user or agent. | name | --actor, --mode, --ttl |
glyph work heartbeat <name> | Refresh an active claim. | name | --actor, --ttl |
glyph work release <name> | Release an active claim. | name | --actor |
glyph work conflicts <name> | Detect conflicts with other active work. | name | None |
glyph work depend <work> <depends-on> | Record ordering between work contexts. | work, depends-on | None |
glyph work prune <name> | Remove a completed work projection while retaining graph history. | name | None |
glyph work discard <name> | Prototype placeholder for policy-controlled discard. | name | Not implemented in prototype 0 |
File Commands
| Command | Purpose | Arguments | Flags |
|---|---|---|---|
glyph read <work> <path> | Read a file from a work context. | work, path | None |
glyph write <work> <path> | Write stdin into a file in a work context. | work, path | --reason |
glyph project <work> <dir> | Materialize a work context into a filesystem directory. | work, dir | None |
glyph diff <work> | Show file-level changes in a work context. | work | None |
glyph read --json returns UTF-8 content directly when possible and base64 for binary data.
Snapshot And Publication Commands
| Command | Purpose | Arguments | Flags |
|---|---|---|---|
glyph checkpoint <work> | Create a named milestone snapshot. | work | --message |
glyph publish <work> | Publish a work context into a realm. | work | --to, --mode, --semantic-type, --semantic-scope, --semantic-description |
glyph publication list | List publications. | None | None |
glyph publication inspect <id> | Prototype placeholder for publication metadata inspection. | id | Not implemented in prototype 0 |
squash and preserve. squash publishes the final state as one public transition. preserve keeps the work context’s snapshot history visible in the destination realm.
Hook Commands
| Command | Purpose | Arguments | Flags |
|---|---|---|---|
glyph hook list | List installed local hooks. | None | None |
glyph hook run <event> | Run one local hook event. | event | --work, --to, --mode |
.glyph/hooks/. The currently meaningful events are pre-publish and post-publish.
Documentation And Skill Commands
| Command | Purpose | Arguments | Flags |
|---|---|---|---|
glyph docs list | List documentation bundled into the Glyph binary. | None | None |
glyph docs show <id> | Print one bundled document. | id: document ID from docs list | None |
glyph skills list | List agent skills bundled into the Glyph binary. | None | None |
glyph skills show <name> | Print one bundled agent skill. | name: skill name from skills list | None |
show, the full content.
Git And Remote Commands
| Command | Purpose | Arguments | Flags |
|---|---|---|---|
glyph export git | Export a realm to a clean Git repository. | None | --realm, --out, --gitignore, --gitinclude |
glyph remote add <name> <spec> | Add an export remote. | name, spec | --mode |
glyph remote list | List configured remotes. | None | None |
glyph remote inspect <name> | Show remote metadata. | name | None |
glyph remote sync <name> | Run public export checks, then export and push a remote. | name | --skip-checks, --check |
none, generated, and overwrite. Defaults come from glyph.yaml.
Mount Commands
| Command | Purpose | Arguments | Status |
|---|---|---|---|
glyph mount add <path> <spec> | Planned external source mount registration. | path, spec | Deferred from prototype 0 |
glyph mount list | Planned mount listing. | None | Deferred from prototype 0 |
glyph mount update <path> | Planned mount refresh. | path | Deferred from prototype 0 |
glyph mount inspect <path> | Planned mount inspection. | path | Deferred from prototype 0 |
Visualizer Commands
| Command | Purpose | Arguments | Flags |
|---|---|---|---|
glyph viz export | Export a static local mesh visualizer. | None | --out |
--out is omitted, Glyph reads defaults.viz.export.out from glyph.yaml and falls back to .glyph/visualizer.
Completion And Help
Cobra also provides generated shell completion and help commands:--json command output over parsing help text.