Start typing to search the documentation.

CLI navigation

Intro

Run the CLI in a project to open the full-screen terminal interface:

rewyyn

Pass a directory to work in a different project:

rewyyn ~/code/my-project

Suggested terminals:

Truecolor support gives themes their most accurate colors; terminals without it use an approximation of the available palette.

Automation

Use rewyyn run to submit a prompt without opening the interactive interface. It is designed for scripts, CI jobs, and other workflows that need model output directly in the terminal.

rewyyn run "Explain this repository"

Mini

Use rewyyn mini to start Rewyyn’s minimal interactive interface instead of the full-screen TUI.

rewyyn mini

Run rewyyn mini --help to see its session, model, agent, prompt, and replay options.

Background service

By default, Rewyyn discovers or starts one shared background server for your user account. Every local Rewyyn client connects to that server, which owns sessions, configuration, integrations, permissions, and tool execution.

Use --standalone to run with a private server, or --server to connect to a specific server URL:

rewyyn --standalone
rewyyn --server http://localhost:4096

To make private servers the default for CLI commands instead of starting the shared service, disable it:

rewyyn service set disabled true
rewyyn

This stops the running background service. --server still connects to an explicitly selected server; rewyyn service start can still start the shared service explicitly. To return to automatic service use, run rewyyn service unset disabled. Pairing requires the shared service and is unavailable while it is disabled.

See Troubleshooting for shared service diagnostics and the API reference for server endpoints.

Paths

Print a specific local path for use with other tools:

rewyyn debug paths db
sqlite3 "$(rewyyn debug paths db)"

The optional selector accepts db, home, data, config, cache, state, tmp, bin, log, or repos and prints only the path and a newline. The database path respects the release channel and REWYYN_DB; relative database overrides resolve under the data directory, and :memory: is printed as-is. This command does not start a server or open the database.

Omit the selector to show all paths with labels:

rewyyn debug paths

Uninstall

Preview the files and installation that will be removed:

rewyyn uninstall --dry-run

Run rewyyn uninstall to confirm removal. Rewyyn stops registered background services and persistent terminals before removing the global cache directory, which is shared by Rewyyn versions and channels. Session data, configuration, and state are never removed.

  • --force (-f) skips confirmation; use it for noninteractive removal.
  • Package-manager installations use the detected package manager. Curl installations print the final command to remove the executable manually.