@archon-research/uikit-cli 0.1.0 → 0.2.0

package/README.md

@@ -1,53 +1,62 @@
 # @archon-research/uikit-cli
 
-CLI for managing local uikit package linking in consumer workspaces.
+CLI tool for local package linking during active development with consumer repositories.
 
 ## Installation
 
-Once published to GitHub Packages, install globally:
-
 ```bash
-npm install -g @archon-research/uikit-cli
+npm install --save-dev @archon-research/uikit-cli
 ```
 
-For development, link locally:
+## Usage
+
+### Link uikit packages into a consumer repository
+
+From your consumer repository:
 
 ```bash
-cd /path/to/uikit/packages/uikit-cli
-npm link
+npm run uikit:link
 ```
 
-## Usage
+This command links all `@archon-research/*` packages from your local uikit monorepo into your consumer project, allowing you to develop packages and see changes immediately.
 
-### Link local uikit packages
+Add this script to your consumer's `package.json`:
 
-```bash
-uikit-cli link
+```json
+{
+  "scripts": {
+    "uikit:link": "uikit-cli link",
+    "uikit:unlink": "uikit-cli unlink"
+  }
+}
 ```
 
-Automatically detects the consumer workspace root by walking up to the nearest `package.json` with a `workspaces` field. Links all `@archon-research/*` packages that the consumer depends on.
+### Restore registry versions
 
-### Unlink local packages (restore registry versions)
+When co-development is complete, restore published versions from npm:
 
 ```bash
-uikit-cli unlink
+npm run uikit:unlink
 ```
 
-Attempts to unlink all local uikit packages and restore registered versions. If packages are not yet published, keeps local links in place.
+## How it works
 
-### Working from any subdirectory
+The CLI manages workspace package links by:
 
-The CLI works from any directory within a workspace:
+1. Discovering linked `@archon-research` packages in your local uikit monorepo
+2. Creating file links in your consumer repository's `node_modules`
+3. Reversing the process with `unlink` to restore registry-installed packages
 
-```bash
-cd my-consumer/src/explorer
-uikit-cli link  # auto-detects workspace root and links packages
-```
+The CLI automatically detects the consumer workspace root and all dependent packages, working from any directory within the workspace.
 
-## How it works
+## Requirements
+
+- Local clone of the uikit monorepo
+- Node.js and npm installed
+
+## See also
 
-1. **Auto-detection**: Walks up from current working directory to find the nearest `package.json` with a `workspaces` field
-2. **Discovery**: Queries locally available uikit packages and determines which ones are needed by consumer workspaces
+- [Development guide](../../DEVELOPMENT.md#local-co-development-with-a-consumer-repository) for detailed local development workflow
 3. **Linking**: Uses `npm link` to establish local package resolution
 4. **Graceful fallback**: On unlink, checks if packages are published; if not, keeps local links to prevent breaking changes
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@archon-research/uikit-cli",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "type": "module",
   "description": "CLI for managing local uikit package linking in consumer workspaces",
   "scripts": {
@@ -12,7 +12,6 @@
     "uikit-cli": "./dist/cli.js"
   },
   "publishConfig": {
-    "registry": "https://npm.pkg.github.com",
     "access": "public"
   },
   "devDependencies": {
@@ -21,5 +20,8 @@
   },
   "files": [
     "dist"
-  ]
+  ],
+  "repository": {
+    "url": "https://github.com/archon-research/uikit"
+  }
 }