CJTaskrunner

CJTaskrunner is a small task runner for project-local commands. Put the commands a project needs in a cjtasks file, add short descriptions where they help, and run them with cj <taskname>.

The language of the cjtasks file is inspired by YAML, but is actually a purpose-made Domain Specific Language. It is similar to make but without all of the declarative and build features.

Because of this it offers an excellent set of ergonomic features such as a dead-simple syntax, flat directives, and bareword strings.

check:
  @desc run the project checks
  cargo test --locked

frontend:
  @desc run the frontend preview
  npm run

> cj check

CJTaskrunner is meant to be a command catalog, not a replacement for Cargo, npm, Python, Docker, or shell scripts. It gives those tools short, discoverable project names.

Start Here

• Install - get the cj executable.
• Manual - common taskfile patterns.
• Integrations - wrap npm, Cargo, Python, Docker, and CI commands.
• Ecosystem - editors, install paths, and examples.

Reference

• CLI
• Taskfile Format
• Directives
• Variables

Explanation

• Philosophy
• Comparisons