simplecloud 0.0.1-beta.10

package/README.md

@@ -0,0 +1,123 @@
+# SimpleCloud CLI
+
+A command-line interface tool for SimpleCloud.
+
+## Development
+
+### Prerequisites
+
+- Node.js >= 18.0.0
+- Bun (for development)
+
+### Setup
+
+Install dependencies:
+
+```bash
+bun install
+```
+
+### Development
+
+**Development Watcher (Recommended)**
+
+Run with automatic rebuilding on file changes:
+
+```bash
+bun run dev
+```
+
+This will:
+- 🔧 Start a file watcher
+- 📁 Watch all `.ts` files in `src/`
+- 🔄 Automatically rebuild `dist/` on changes
+- ⚡ Debounced builds (300ms delay)
+- 🛑 Stop with `Ctrl+C`
+
+**Local Package Testing**
+
+Create a local package file for testing:
+
+```bash
+bun run local:pack  # Creates temp/simplecloud.tgz (no version in filename)
+```
+
+### Building
+
+Build the CLI for distribution:
+
+```bash
+bun run build
+```
+
+This creates optimized, minified bundles in the `dist/` folder that include all dependencies.
+
+### Testing
+
+Test the built CLI:
+
+```bash
+bun run test:cli
+```
+
+Test specific commands:
+
+```bash
+node dist/cli.js --help
+node dist/cli.js start group test
+```
+
+### Local Development
+
+**Option 1: Shell Alias (Recommended - No Conflicts)**
+
+Create a local `scl` alias that points to your development build:
+
+```bash
+bun run local:setup  # Creates 'scl' alias in ~/.zshrc
+source ~/.zshrc      # Reload shell config
+```
+
+Now you can use `scl` for local testing without conflicting with published versions:
+
+```bash
+scl --help                    # Local development
+scl start group mygroup
+```
+
+**Pro Tip**: Run `bun run dev` in one terminal and use `scl` commands in another terminal for seamless development with auto-rebuilding!
+
+**Option 2: npm link (Development Symlink)**
+
+Creates symlinks to global npm location (uses same command names):
+
+```bash
+bun run local:link    # Link for development
+bun run local:unlink  # Unlink when done
+```
+
+**Option 3: Direct Execution**
+
+Run the built CLI directly:
+
+```bash
+bun run build
+node dist/cli.js --help
+node dist/cli.js start group mygroup
+```
+
+## Generating API
+
+```bash
+bunx swagger-typescript-api generate -p swagger.yaml -o src/lib/generated -n simplecloud-api.ts --sort-types --single-http-client --clean-output
+```
+
+
+## Publishing to npm
+
+1. Update the version in `package.json`
+2. Update author, repository, and other metadata fields
+3. Ensure you're logged into npm: `npm login`
+4. Publish: `npm publish`
+
+The `prepublishOnly` script will automatically build the project before publishing.