simplecloud 0.0.1

package/README.md

@@ -0,0 +1,96 @@
+# 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
+
+Run the CLI in development mode:
+
+```bash
+bun run dev
+```
+
+### 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 Installation
+
+To install the CLI globally on your system for testing:
+
+```bash
+bun run local:install
+```
+
+Then you can use it anywhere:
+
+```bash
+simplecloud --help
+simplecloud start group mygroup
+```
+
+To uninstall:
+
+```bash
+bun run local:uninstall
+```
+
+## 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.
+
+## Bundle Details
+
+- **Entry Points**: `src/index.ts` (library) and `src/cli.ts` (CLI executable)
+- **Output**: Single minified JavaScript files with all dependencies bundled
+- **Runtime**: Node.js (bundled with `@effect/platform-node`)
+- **Bundle Size**: ~1.3MB for CLI (includes Effect.ts runtime)
+- **No Source Code Exposure**: Only minified bundles are published
+
+## CLI Usage
+
+```bash
+simplecloud --help
+simplecloud start group <group-name>
+```