@arcote.tech/arc-cli 0.1.1

package/README.md

@@ -0,0 +1,67 @@
+# @arcote.tech/cli
+
+CLI tool for Arc framework.
+
+## Installation
+
+```bash
+bun install -g @arcote.tech/cli
+```
+
+Or use it directly with npx:
+
+```bash
+npx @arcote.tech/cli dev
+```
+
+## Usage
+
+### Development Mode
+
+Run the development mode to watch and build your Arc packages:
+
+```bash
+arc dev
+```
+
+This will:
+
+1. Find all `arc.config.ts` files in your workspace
+2. Generate client-specific TypeScript definitions based on the clients specified in the config
+3. Build each client using Bun with the appropriate define constants
+4. Watch for changes and rebuild automatically
+5. Generate TypeScript declaration files
+
+## Configuration
+
+Create an `arc.config.json` file in your package:
+
+```json
+{
+  "file": "index.ts",
+  "outDir": "dist",
+  "clients": ["browser", "mobile app", "server", "api"]
+}
+```
+
+The CLI will generate the following constants for each client:
+
+- `BROWSER` (true/false)
+- `NOT_ON_BROWSER` (true/false)
+- `ONLY_BROWSER` (true/false)
+
+And similarly for other clients, with spaces converted to underscores:
+
+- `MOBILE_APP`
+- `NOT_ON_MOBILE_APP`
+- `ONLY_MOBILE_APP`
+- etc.
+
+These constants can be used in your code to conditionally include or exclude code for specific clients:
+
+```typescript
+export const myFeature = context().pipe([
+  NOT_ON_BROWSER && myBrowserSpecificFeature,
+  API_ONLY && myApiOnlyFeature,
+]);
+```