From a921ef8725af28fc15158c08268b4c14c680ca8e Mon Sep 17 00:00:00 2001 From: Claudio Ortolina Date: Thu, 12 Mar 2026 14:27:02 +0000 Subject: [PATCH] Document mise tasks for agents --- AGENTS.md | 6 +++ docs/available-tasks.md | 95 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 101 insertions(+) create mode 100644 docs/available-tasks.md diff --git a/AGENTS.md b/AGENTS.md index 20be4352..95dc9a32 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -6,6 +6,12 @@ @docs/project-conventions.md +# Commands and tasks + +The project uses [mise](https://mise.jdx.dev/) to manage high level configuration and tasks. + +@docs/available-tasks.md + ## usage_rules usage diff --git a/docs/available-tasks.md b/docs/available-tasks.md new file mode 100644 index 00000000..d8a3afe1 --- /dev/null +++ b/docs/available-tasks.md @@ -0,0 +1,95 @@ +## `ci:watch` + +- **Usage**: `ci:watch` + +Watch CI running + +## `dev:console` + +- **Usage**: `dev:console` + +Run the application attached to an IEx console + +## `dev:fix-translations` + +- **Usage**: `dev:fix-translations` + +Fix translation file conflicts + +## `dev:lint` + +- **Usage**: `dev:lint` + +Run static checks for code formatting, translations, quality + +## `dev:outdated` + +- **Usage**: `dev:outdated` + +Show outdated dependencies. + +## `dev:partitioned-test` + +- **Usage**: `dev:partitioned-test ` + +Run project tests + +### Arguments + +#### `` + +The number of the partition + +## `dev:precommit` + +- **Usage**: `dev:precommit` + +Run checks before a commit + +## `dev:readme` + +- **Usage**: `dev:readme` + +Render README.md with GitHub Flavored Markdown preview + +## `dev:setup` + +- **Usage**: `dev:setup` + +Setup the local development environment + +## `dev:update` + +- **Usage**: `dev:update` + +Update dependencies + +## `prod:backup` + +- **Usage**: `prod:backup` + +Backup the production database to the local development env + +## `prod:deploy` + +- **Usage**: `prod:deploy` + +Deploy on production and monitor deployment + +## `prod:prune-backups` + +- **Usage**: `prod:prune-backups` + +Remove locally downloaded production database backups + +## `prod:test` + +- **Usage**: `prod:test` + +Run HTTP tests against production + +## `test` + +- Depends: dev:partitioned-test 1, dev:partitioned-test 2 + +- **Usage**: `test`