docs(cli): add README

steinjs · Jul 21, 2024 · 5c271e9 · 5c271e9
1 parent 4c74050
commit 5c271e9
Showing 1 changed file with 24 additions and 0 deletions.
diff --git a/packages/cli/README.md 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).