Skip to main content

SpecStory CLI configuration

The SpecStory CLI wrapper works out of the box with minimal setup.

Commands

CommandDescriptionExamples
helpShow help informationspecstory help
specstory help run
checkVerify that terminal agents are installed and accessible to SpecStoryspecstory check
runLaunch Claude Code, Cursor CLI, or Codex CLI with autosave to local Markdown (and SpecStory Cloud if logged in)specstory run claude
specstory run cursor
specstory run codex
syncConvert existing sessions to Markdown and optionally sync them to SpecStory Cloudspecstory sync
specstory sync -s <sessionId>
loginAuthenticate with SpecStory Cloudspecstory login
logoutSign out of SpecStory Cloudspecstory logout
versionDisplay the current SpecStory versionspecstory version

Flags

FlagDescriptionUsage
-c, --commandUse a custom terminal-agent command or argsspecstory run claude -c "claude --dangerously-skip-permissions"
-s, --sessionConvert a specific session to Markdownspecstory sync claude -s <sessionId>
--consoleStream log output to stdoutspecstory sync --console
--logWrite logs to ./specstory/debug/debug.logspecstory sync --log
--debugInclude debug-level output (requires --console or --log)specstory sync --log --debug
--silentSuppress non-error outputspecstory sync --silent
--no-cloud-syncDisable cloud sync even when authenticatedspecstory sync --no-cloud-sync
--no-usage-analyticsOpt out of usage analyticsspecstory run cursor --no-usage-analytics
--no-version-checkSkip the version checkspecstory run codex --no-version-check
--output-dirWrite Markdown exports to a custom directoryspecstory sync --output-dir ~/my-agent-sessions
-h, --helpShow help information for a commandspecstory -h
-v, --versionShow the current SpecStory versionspecstory -v

Default behavior

  • Session storage: .specstory/history/ in the working directory.
  • Cloud sync: Enabled when logged in with specstory login unless --no-cloud-sync is provided.
  • Session sources: Reads from locations like ~/.claude/projects/ and ~/.cursor/chats/.
  • Output format: Markdown files stamped with the session timestamp.

Project scaffolding

The first run inside a project creates:
  • .specstory/ for state and configuration.
  • .specstory/history/ for exported Markdown.
  • .specstory/.project.json for project bookkeeping.
The CLI wrapper favors convention over configuration. Most projects will never need to modify defaults.

Debugging

Use console streaming or log files to inspect processing details.
# Run interactively with verbose output
specstory run claude --console --debug

# Capture logs without console noise
specstory run cursor --log

# Preview which sessions will be processed
specstory sync codex --console | grep "Parsing session"
Log output highlights:
  • Which session files are being parsed.
  • Where Markdown exports are written.
  • Errors encountered during capture or sync.
I