FAQ

Run the install script: Or clone and install manually: See full install guide.

macOS or Linux, Python 3.10+, Git, and Ollama with a model installed (e.g. ollama pull qwen2.5:14b). NVIDIA GPU recommended but not required.

Only for initial setup (downloading models and dependencies). After that, SQ2 runs fully offline. No internet required at runtime.

SQ2 is a local execution system for engineering work. It reads your codebase, plans changes, executes them, and verifies the results. It operates through structured workflows: analysis, test generation, and automated fixing.

Workflows are predefined execution patterns: Each workflow follows the same cycle: plan, execute, verify.

Use the task command with a natural language description: SQ2 will plan the steps, show you the plan, and ask for approval before executing.

Run sq2 run without --workflow to enter the interactive shell. This gives you access to all commands: reading files, editing, searching, running tasks, reviewing changes, and more. Type help inside the shell for the full command list.

No. SQ2 runs entirely on your machine. Models run locally via Ollama. No code, no data, no telemetry is sent to any external service.

No. The policy engine restricts all writes to the project root directory. Writes outside the project are blocked. Dangerous commands (rm -rf, force push, etc.) are blocked by default.

Add --dry-run to any workflow to see the execution plan without making changes: This shows target files, planned steps, and risk flags. No files are modified.

No. SQ2 never commits, pushes, or modifies git history automatically. All git operations require your explicit action.

The CLI is installed inside a virtual environment. Activate it first: Then sq2 version should work.

SQ2 requires Python 3.10 or higher. Check your version: On macOS, install via Homebrew: brew install python@3.12. On Linux, use your package manager or python.org.

Install Ollama from ollama.com, then start it and pull a model: Run sq2 doctor to verify the Ollama API is reachable.

Do not use sudo. SQ2 installs into a local virtual environment in the project directory. If you see permission errors, check that you own the project directory and that .venv is not locked by another process.

Yes. SQ2 operates on your local filesystem. If you can clone the repo, SQ2 can work with it. No tokens, no API keys, no access delegation required.

SQ2 indexes up to ~1000 files efficiently using TF-IDF search and function-level chunking. Execution is scoped to 5 files per tranche, so even in large repos, each task is bounded and manageable.

Yes. The policy engine classifies every action as safe, caution, or blocked. Dangerous commands are blocked by default. Caution-level commands require your explicit approval. You can review the policy rules in src/sq2_ai/policy.py.

Yes. In the interactive shell: Files are saved to sq2_report/ in your project directory.