Docs

Osmogrep Documentation

Osmogrep is an interactive terminal experience where you can type prompts, review generated code, run shell commands, and iterate with the agent in real time.

Quickstart

Install and launch inside any git repository:

$ cargo install osmogrep
$ cd your-repo
$ osmogrep

For proper installation details, see Install page.

Agent Interaction

Type naturally to ask Osmogrep to inspect code, write patches, generate tests, and explain decisions. You can converse with it directly and watch output stream in the terminal UI.

Find risky code paths around auth token refresh.
Generate tests for the changed files and run them.
Patch the flaky test and explain what changed.

Shell Commands (!)

Prefix with ! to run shell commands directly from Osmogrep.

!git status
!rg "TODO|FIXME" src
!cargo test -q

Slash Commands (/)

Osmogrep supports explicit slash commands for session control and utility actions.

/help
/clear
/key
/quit
/q
/exit

FAQ

Can I just type normal instructions?

Yes. Anything that is not a slash command is treated as input to the agent conversation.

How do I run shell commands in-session?

Use the ! prefix to execute shell commands directly.

Which slash commands are available?

Use /help to see all commands including clear, key, quit, and exit controls.