Start here
Run a coding agent from TypeScript, then add checks and workflows as you need them.
What you can do with Outpost
Section titled “What you can do with Outpost”Outpost is a TypeScript library for running coding agents on Git repositories. Your code chooses the agent, its execution environment and the branch where it works. The result includes its answer, commits and reported token usage.
Start with a single task. When you need several steps, a workflow connects them and passes their results from one task to the next.
Run your first task
Section titled “Run your first task”Follow these three pages in order. They use Docker and Codex to give you a working starting point.
Understand the building blocks
Section titled “Understand the building blocks”An agent does the work, a sandbox runs its commands, and a workspace is the checkout it edits. You choose these separately. How Outpost runs a task explains their lifetimes and what happens to the files.
For the exact options and return types of a function, open the API reference. The guide focuses on how to use those functions together.
Continue with your own use case
Section titled “Continue with your own use case”Pick the topic that matches your next step. You can return to the other guides when you need them.
- Write agent instructionsUse text or a reusable Markdown file.
- Check work and retryRun tests and send failures back for another attempt.
- Choose an agentConfigure the agent independently of its sandbox.
- Reuse a sandboxRun commands and several agent turns on the same files.
- Wait for approvalRequire approval before a later task runs.
- Run in CIExecute your script in an automated job.
For a complete example, try fixing a failing build or building a development workflow.