Skip to main content

Documentation Index

Fetch the complete documentation index at: https://auto-sop.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
pause

Temporarily disable capture and the learner. Hooks remain installed but stop recording. Useful when working on sensitive code or during large refactors where captures would be noisy. 
auto-sop pause [options]

​
Options

OptionDescription
--project <path>Project root (default: current directory)

​
Example

auto-sop pause

auto-sop paused for /Users/you/projects/my-app
Captures and learner disabled. Run 'auto-sop resume' to re-enable.
Pausing is project-scoped. Other projects continue capturing normally.

​
resume

Re-enable capture and the learner after pausing. 
auto-sop resume [options]

​
Options

OptionDescription
--project <path>Project root (default: current directory)

​
Example

auto-sop resume

auto-sop resumed for /Users/you/projects/my-app
Captures and learner re-enabled.

​
statusline

Print [sop:on] or [sop:off] for terminal prompt integration. Designed to be embedded in your shell prompt (PS1/PROMPT) so you always know if auto-sop is active. 
auto-sop statusline [options]

​
Options

OptionDescription
--project <path>Project root

​
Example

auto-sop statusline

[sop:on]

​
Shell Integration

Add to your .zshrc or .bashrc: 
# Add auto-sop status to your prompt
PROMPT='$(auto-sop statusline 2>/dev/null) '$PROMPT
This gives you a persistent visual indicator: 
[sop:on] ~/projects/my-app $
The 2>/dev/null suppresses errors if auto-sop isn’t installed in the current directory, keeping your prompt clean in non-auto-sop projects.

​
Pause/Resume Workflow

A typical workflow when handling sensitive operations: 
# About to work on auth secrets
auto-sop pause

# ... do sensitive work ...

# Done, re-enable
auto-sop resume
Your terminal prompt updates automatically if you have statusline integrated: 
[sop:off] ~/projects/my-app $ auto-sop resume
[sop:on] ~/projects/my-app $