Files
daedalus/README.md
T

45 lines
1.4 KiB
Markdown

# daedalus (template)
Starter repository for daedalus:
one CLI, many small scripts, each with tests.
```bash
daedalus <name> [args...] # run a script
daedalus <category> [category...] # list scripts in the categories (AND)
daedalus --list # list everything
```
**[Install, usage, and development](./INSTALL.md)** ·
[SPEC](./SPEC.md) (how the repo is maintained) ·
[CHANGELOG](./CHANGELOG.md)
## Available scripts
| Script | Type | Categories | What it does |
| --- | --- | --- | --- |
| `hello` | Python | test | Prints a hello line and the daedalus version |
Run the sample script:
```bash
daedalus hello # hello from daedalus 0.2.0
daedalus test hello # same, through the category prefix
daedalus test # list the scripts in the 'test' category
```
`daedalus --list` prints the version, a `script` / `type` / `categories`
table, and each description wrapped under its row.
## Getting started
1. Clone or copy this template and name the Git remote for your team.
2. Add a script under `python/src/`, `bash/`, `powershell/`, or `batch/`
(see [SPEC layout](./SPEC.md#2-layout)).
3. Register it in `daedalus/registry.py`, add a row to the table above,
write tests, bump `version` in `pyproject.toml`, and run
`python autotest.py`.
`hello` is the sample script: copy its file, registry entry, README row,
and tests to add your own. Unknown names exit with code 2 and suggest
close matches.