---


---

skuba is a toolkit for backend application and package development on SEEK's gravel and paved roads:

- Write in [TypeScript]
- Enforce coding standards with [ESLint] and [Prettier]
- Test with [Jest]
- Deploy with [Gantry] or the [AWS CDK]

[aws cdk]: https://docs.aws.amazon.com/cdk/latest/guide/work-with-cdk-typescript.html
[gantry]: https://backstage.myseek.xyz/docs/default/component/gantry/

It provides you with:

- [CLI] commands for developing your project
- [Templates] to base your backend application or package on
- [Development] and optional [runtime] APIs for cross-cutting concerns

Learn more about skuba and contribute to it.

---

skuba is distributed as an npm package.

In projects that list it as a devDependency,
usage may look something like this:

``shell


Install project dependencies.

pnpm install

Run the skuba CLI.

pnpm exec skuba help
`

When starting a new project, using the latest version is recommended:

`shell
pnpm dlx skuba init
``

If you're new here, jump ahead to the [CLI] section to [create a new project] or [update an existing one].

[cli]: ./docs/cli
[create a new project]: ./docs/cli/init.md
[development]: ./docs/development-api
[eslint]: https://eslint.org/
[jest]: https://jestjs.io
[prettier]: https://prettier.io/
[runtime]: ./docs/runtime-api
[templates]: ./docs/templates
[typescript]: https://www.typescriptlang.org/
[update an existing one]: ./docs/cli/configure.md