OpenSIP CLI

The opensip command — codebase analysis from the command line.

Install

curl -fsSL https://opensip.ai/cli/install.sh | bash

Quick start

cd your-project
opensip                            # welcome screen
opensip init                       # detect language, scaffold layout
opensip fit --recipe example       # smoke-test the example check
opensip sim --recipe example       # smoke-test the example scenario

What's in the box

• fit — run fitness checks against your codebase (core command).
• fit-list — list available checks.
• fit-recipes — list available recipes.
• report — open an HTML report in your browser.
• sim — run simulation recipes.
• init — detect language and scaffold opensip-cli.config.yml plus example checks/recipes/scenarios under opensip-cli/.
• sessions list|purge — manage stored session data.
• configure — set up an OpenSIP Cloud API key for --report-to.
• plugin list|add|remove|sync — manage npm-installed plugin packages declared in plugins.<domain>: (project-local).
• completion — print a shell-completion script for bash / zsh / fish.
• uninstall — remove ~/.opensip-cli/ (user-level cloud config) for a clean-slate reset. Project-local opensip-cli/.runtime/ is gitignored — delete it manually if needed.

The CLI is a generic tool dispatcher: fitness and simulation are first-party tools, but the underlying CLI doesn't hardcode either. Adding a new tool — audit, lint, bench, whatever — is a plugin operation.

Full documentation

See the repository README for the complete reference — authoring plugins, CI integration, cloud reporting, configuration schema, and more.

License

Apache-2.0