Docs

For Northwick 0.8.0, the early access build. Last updated 29 October 2026. See the changelog for what changed.

Northwick hasn't launched. These docs describe the build early access teams will get, and parts of them are still being written.

Quickstart

1. Get an invite. Early access is invite only. Join the waitlist and we'll email you when there's room for your team.

2. Install the app. Follow the link in the invite and install Northwick on your GitHub organisation or GitLab group. Choose which repositories it can see. You can change this later.

3. Add a config file. This step is optional. Without it, Northwick reads your CI config to find your commands. To set them yourself, commit .northwick.yml to the root of the repository:

   # .northwick.yml
   commands:
     test: npm test
     lint: npm run lint
     build: npm run build
   
   budget:
     tasks_per_month: 40
   
   branch_prefix: northwick/
   
   ignore:
     - migrations/
     - vendor/

4. Assign an issue. Write an issue that describes the change, then assign it to the northwick user. Small, specific issues work best. "The date picker accepts 30 February" will go better than "fix the forms".

5. Approve the plan. Northwick comments on the issue with what it intends to change. Reply with corrections, or reply go to let it start.

6. Review the pull request. Northwick works on its own branch, runs your commands, and opens a pull request linked to the issue. Review it like any other. Comment on the pull request to ask for changes and it will pick them up.

Configuration

Everything goes in .northwick.yml at the root of the repository. Every key is optional.

• commands.test, commands.lint, commands.build: shell commands Northwick runs before it opens a pull request. If it can't get them passing, it opens a draft pull request and says what is still failing.
• budget.tasks_per_month: the most tasks this repository can run in a calendar month. See Budgets.
• branch_prefix: the start of every branch name Northwick creates. Defaults to northwick/.
• ignore: paths Northwick must not edit. It can still read them.

A full reference with every key and default is still being written.

How a task runs

1. Someone assigns an issue to northwick.
2. Northwick starts a new sandbox and checks out your default branch.
3. It reads the issue and the code around it, then posts a plan on the issue.
4. Once someone replies go, it makes the change on a new branch and runs your commands, fixing what fails.
5. It pushes the branch, opens a pull request, and links it from the issue.
6. The sandbox is deleted.

Northwick never pushes to your default branch and never merges a pull request. We recommend branch protection on your default branch anyway.

Sandboxes

Each task runs in a new container. It has your repository, the tools needed to run your commands, and network access to public package registries. It does not get your CI secrets or environment variables. When the task ends, the container and everything in it is deleted.

If your tests need a database or other services, say so in the issue for now. Configurable services are planned and not in the early access build yet.

Budgets

Each repository can have a monthly task budget. When a repository reaches it, Northwick comments on the next assigned issue to say so and doesn't start. Budgets reset at midnight UTC on the first of each month. Tasks that fail still count.

Repository budgets sit inside your plan's monthly allowance: 20 tasks on Solo Free, 200 on Solo Pro, and 200 per seat on Team, shared across the team. Use them to stop one busy repository using up everyone's tasks.

Getting help

Email hello@northwickcode.com. During early access, the people who reply are the people building it. To report a security problem, see Security.