Skip to content

quickstart.md

Latest commit

 

History

History
20 lines (14 loc) · 854 Bytes

quickstart.md

File metadata and controls

20 lines (14 loc) · 854 Bytes
Raw

Quickstart

This quickstart assumes:

  • You have a git repository to patch.
  • You can provide a verify command that exits non-zero on failure.

Minimal Worktree Run

Example (Windows PowerShell):

bun run  -- -r "C:\path\to\your-repo" -f "src\\index.js" --instruction "Add a comment as the first line inside createSafeEnvProxy" --verify "bun -e \"process.exit(0)\"" -cs worktree --verbose

Notes

  • If SALMONLOOP_API_KEY (or legacy S8P_API_KEY) is not set, SalmonLoop uses a stub LLM and is not useful for real patching.
  • You can also place repo-local config at <repoRoot>/.salmonloop/config/config.json (local-only, gitignored).
  • This repo includes a config.example.json at the project root. You can copy it into your target repo and point --config at it.
  • Use --dry-run to prevent writing to the main workspace.