From 5c271e99870d338f1f64b018352153214bd31ddf Mon Sep 17 00:00:00 2001 From: Mikkel ALMONTE--RINGAUD Date: Sun, 21 Jul 2024 02:41:00 +0200 Subject: [PATCH] docs(cli): add README --- packages/cli/README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 packages/cli/README.md diff --git a/packages/cli/README.md b/packages/cli/README.md new file mode 100644 index 0000000..829b341 --- /dev/null +++ b/packages/cli/README.md @@ -0,0 +1,24 @@ +# Stein CLI + +## Usage + +```bash +npx @steinjs/cli +pnpx @steinjs/cli +bunx @steinjs/cli +``` + +## Commands + +```bash +stein create project-name # Create a new Stein project in "project-name" directory +stein dev # Start the development server + +# todo: +stein add plugin-name # Add plugin-name to the current project. +stein build +``` + +## Credits + +This CLI was hugely inspired (and some code was borrowed) from the [Astro CLI](https://github.com/withastro/astro/blob/main/packages/astro/src/cli).