emdash-run
Work on an EmDash site with a few mise tasks: make a site, run it, fill it, check it, sign in, add plugins, deploy it, preview it.
A task brings the site to a state. It first reaches the states that one stands on, with EmDash’s, Astro’s and wrangler’s own commands, and skips each that is already so: a task is safe to run again, and the second run is short.
Start with Getting started.
The map
| You have | It gives you | Tasks |
|---|---|---|
| An empty repo, or an EmDash site | A site on this machine: the dev site, and the built site that behaves like a deployed one | site:*, emdash, model:sync |
| A site, and a question | Where it is, state by state, and what a task would do | site:status, plan |
| A site with nothing in it | What a seed file names, and something to show in every feature | site:seed, site:demo |
| A site that needs someone signed in | A machine, an agent or a person signed in, with or without a browser | signin:* |
| A site that needs plugins | Your own, one from npm, or one from EmDash’s registry; a check that it loads, and seven doing their real thing | plugin:* |
| A Cloudflare account | The site deployed, backed up, rolled back, and previewed beside itself | live:*, content:pull |
One rule says where a task acts: no flag is this machine, --live is the deployed site (This machine or deployed, with the three tasks that fill a site and never act on a deployed one).
What is generated
Don’t edit these: change what they are written from.
| Page or file | Written by | From |
|---|---|---|
| Tasks, The tasks for working on this repo | mise run docs:setup (charter docs-tasks) | each task’s description, arguments and flags, in the order they are written: tasks.toml for the first, dev.toml and charter’s own tasks for the second |
| What the tests showed | mise run docs:setup | tests/<group>/last-run.txt, which a whole group run at the level all writes on a developer’s machine |
scripts/core/emdash-api.d.ts | mise run dev:api-types | scripts/core/emdash-openapi.json, a saved copy of EmDash’s own list of its requests |
_config.yml, _sass/, llms.txt, Writing docs, How this repo is kept and repo/ | mise run docs:setup | charter |
.github/ISSUE_TEMPLATE/, .github/labels.tsv, .github/workflows/repo-check.yml, renovate.json | mise run repo | charter |
Every file charter writes says so in its first lines. charter files lists them all, and whether each still matches.
Index
| Page | What it is for |
|---|---|
| Getting started | From nothing to a running site you are signed in to; what a task does, and how to see it |
| Guides | One job per page |
| An existing site | Using the tasks on a repo that already is an EmDash site |
| This machine or deployed | The one rule, the two sites on this machine, and the tasks that never act on a deployed site |
| Sign in | The four ways, which to use, and connecting an agent to the site’s MCP server |
| Seed files | Filling a running site from a seed file, and what a seed file cannot say |
| Deploy | Putting a site on Cloudflare, with sign-in and content |
| Preview | The site on an address of its own, beside the live one |
| Plugins | Making one, adding one, installing from the registry, seeing seven work |
| Several sites at once | Two projects, or several agents, on one machine |
| Reference | Tables: tasks, settings, templates, plugins |
| Tasks | Every task: what it does, its arguments and flags |
| The tasks for working on this repo | The same, for dev:*, check and the tasks charter gives |
| What the tests showed | Every test step of the last recorded run, passed or failed, with its time |
| Settings | Everything you can set in mise.toml |
| Templates | The eight kinds of site site:new makes |
| Favourite plugins | What plugin:favourites installs, why, and every plugin that was tried |
| How to help | |
| How to help | Setting up, the test, the site in this repo, how it is built, releases |
| How this repo is kept | What is the same in every repo charter keeps: the rules they share |
| Rules | This repo’s own rules, which add to those |
| Upstream issues | Every workaround, and the issue it waits for |
| Writing docs | How these pages are written |