Skip to content

Commit eecc424

Browse files
committed
docs: add CLI guide
1 parent 2a72f6f commit eecc424

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ cargo run -p raw --example basic
4444
- `docs/DEVELOPMENT.md`
4545
- `docs/CONTRIBUTING.md`
4646
- `docs/CONFIGURATION.md`
47+
- `docs/CLI.md`
4748

4849
## License
4950
Licensed under Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International.

docs/CLI.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# CLI
2+
3+
Raw ships with a small CLI for scaffolding new projects.
4+
5+
## Commands
6+
7+
### `raw new <name>`
8+
Creates a new Raw application in the named directory.
9+
10+
```bash
11+
cargo run -p raw-cli -- new my-raw-app
12+
```
13+
14+
### `raw routes`
15+
Planned command to display registered routes.
16+
17+
### `raw run`
18+
Planned command to run the development server.

0 commit comments

Comments
 (0)