Getting Started
Install ShioriCode and run your first coding session in minutes. ShioriCode requires an active paid Shiori subscription.
Prerequisites
You need an active paid Shiori subscription, the following tools installed, and at least one AI provider.
- Paid Shiori plan - Any paid Shiori subscription includes full ShioriCode access
- Bun - Package manager and build tool. Install from
curl -fsSL https://bun.sh/install | bash - Git - Required for checkpointing and workspace operations
Provider Setup
You need at least one AI provider configured. ShioriCode currently supports six:
Codex (Recommended)
- Install the Codex CLI and ensure it's on your PATH
- Authenticate Codex (
codex login) - ShioriCode handles the rest automatically
Uses your own ChatGPT / OpenAI subscription - usage counts toward that plan, not your Shiori plan.
Claude
- Install the Claude CLI and ensure it's on your PATH
- Authenticate with your Anthropic credentials
- ShioriCode will detect the authenticated CLI automatically
Uses your own Claude / Anthropic subscription - usage counts toward that plan, not your Shiori plan.
Gemini
- Install the Gemini CLI and ensure it's on your PATH
- Authenticate with your Google account (or supply a Google Cloud project)
- ShioriCode will detect the authenticated CLI automatically
Uses your own Google account or Google Cloud project - usage counts toward that plan, not your Shiori plan.
Cursor
- Install the Cursor agent CLI (binary name
agent) and ensure it's on your PATH - Sign in to Cursor through the CLI
- ShioriCode will detect the authenticated CLI automatically
Uses your own Cursor subscription - usage counts toward that plan, not your Shiori plan.
Kimi Code
- Install the Kimi CLI and ensure it's on your PATH
- Authenticate with your Moonshot / Kimi credentials
- ShioriCode will detect the authenticated CLI automatically
Uses your own Moonshot / Kimi account - usage counts toward that plan, not your Shiori plan.
Shiori
No local installation needed. Sign in with your Shiori account to access the Shiori provider. Access currently requires an active paid Shiori subscription.
Uses your paid Shiori subscription - usage counts toward your Shiori plan limits.
See Providers for detailed configuration options.
Optional: install the ShioriCode companion CLI with npm install --global shiori-cli to get the shiori command in your terminal.
Installation
From Source
git clone the ShioriCode repository
cd shioricode
bun install
Desktop App
Download the latest release for your platform from the desktop app page. Available for macOS (Apple Silicon and Intel), Linux, and Windows for active paid subscribers.
Running ShioriCode
Development Mode
bun run dev
Starts both the server and web UI in development mode. The app will be available at http://localhost:3773.
Production Mode
bun run build
bun run start
Desktop Mode
bun run dev:desktop
Your First Session
- Open ShioriCode in your browser or desktop app
- Select a provider and model from the chat toolbar
- Choose a runtime mode - Full access (no approval prompts) or Supervised (asks before executing)
- Type a message describing what you want to build or fix, and press Enter
- Watch the agent work - file changes appear as diffs, commands run in the integrated terminal
- Review the git checkpoint diff after the turn completes to see exactly what changed
Multiple Dev Instances
Run isolated instances with separate data directories using the SHIORICODE_DEV_INSTANCE environment variable:
SHIORICODE_DEV_INSTANCE=2 bun run dev
This offsets the port and uses a separate data directory, so instances do not interfere with each other.
Next Steps
- Configure providers for your preferred AI models
- Set up keybindings for faster workflows
- Install the companion CLI to manage projects from the terminal