Skip to content

CLI Reference

The gosok binary serves as both the server and the CLI client. When run without arguments, it starts the server. With a subcommand, it calls the running server’s API.

gosok [command] [subcommand] [args] [flags]
CommandDescription
(no args)Start the gosok server
CommandDescription
project listList all projects (alias: ps)
project create <name> --path <dir>Create a project
project update <id> [--name N] [--path P]Update a project
project delete <id>Delete a project
CommandDescription
tab list [project]List tabs, optionally filter by project (alias: ls)
tab create <project-id> [--name N] [--type shell]Create a tab
tab update <id> --name <name>Update a tab
tab delete <id>Delete a tab
tab start <id>Start a tab
tab stop <id>Stop a tab
tab screen <id> [--lines N] [--bytes N]Read terminal output (default: 24 lines)
tab write <id> <text>Write text to terminal input (appends newline)
CommandDescription
msg send <tab-id> <message>Send a direct message
msg send --all <message>Broadcast to all tabs
msg inbox [tab-id]Read inbox (defaults to $GOSOK_TAB_ID)
msg read [tab-id]Mark inbox as read
msg wait [--timeout 30s] [tab-id]Wait for next message
msg feed [message]Post to feed (with arg) or read feed (without)
CommandDescription
notify <title> [--body <text>] [--flag]Send a notification
CommandDescription
setting listList all settings
setting get <key>Get a setting value
setting set <key> <value>Set a setting
setting delete <key>Reset to default
CommandDescription
helpShow help