Skip to content

Getting Started

Katoa is a CI/CD platform. Use our TypeScript SDK to write pipelines, test them locally, then run them on every PR.

Here's how to build, test, and deploy your own Katoa pipeline in under < 2 minutes.

1. Download the katoa CLI

bash
npm install -g @katoahq/katoa
npm install -g @katoahq/katoa
bash
yarn global add @katoahq/katoa
yarn global add @katoahq/katoa
bash
pnpm install -g @katoahq/katoa
pnpm install -g @katoahq/katoa

Note: Katoa requires Docker & deno

2. Create a new pipeline

Navigate to a project and run

bash
katoa init
katoa init

This will create help you the default piplines at .katoa/<pipeline-name>.ts that looks like this

3. Test your pipeline locally

Test changes to your pipelines locally using the katoa CLI

bash
katoa run <pipeline-name>
katoa run <pipeline-name>

4. That's it!

Check out our guides or faq to learn more