CLI Reference
The ShioriCode companion CLI installs the shiori command so you can manage projects, threads, and sessions from the terminal.
Installation
If you're using the desktop app, open Settings and click "Install CLI" to add the shiori command to your PATH.
If you want to install it manually, run npm install --global shiori-cli.
If you're running from source, the CLI is built automatically when you run bun run build.
Commands
shiori open [<folder>]
Open a project in the browser. If no folder is specified, opens the current working directory.
shiori status
Show the local ShioriCode status summary, including the base directory plus project and thread counts.
shiori project list
List all registered projects.
shiori project add
Register a new project with ShioriCode.
shiori thread list
List all threads in the current project.
shiori thread create
Create a new thread in the current project.
shiori thread rename
Rename an existing thread.
shiori thread archive | unarchive
Archive or unarchive a thread. Archived threads are hidden from the default thread list.
shiori thread delete
Permanently delete a thread and its associated data.
shiori thread send
Send a message to a thread, starting a new turn.
shiori session interrupt
Interrupt the currently running session (stops the agent mid-turn).
shiori session stop
Gracefully stop the current session.
Requirements
The ShioriCode server must be running for CLI commands to work. The CLI connects to the same server that powers the web UI.
Related
- Desktop App - Install the CLI from the desktop app settings
- Remote Access - Use the CLI with a remote server