diff --git a/README.md b/README.md index 1e7da10..9f04c7c 100644 --- a/README.md +++ b/README.md @@ -36,22 +36,20 @@ ## Quickstart ```bash -git clone https://github.com/2witstudios/pagespace-cli.git -cd pagespace-cli -npm install # resolves vendored pi workspaces in packages/ -npm run build # required: builds workspace pi packages to dist/ (~3s) +npm install -g pagespace-cli +pagespace ``` -This repo vendors pi via npm workspaces (`packages/`), so you do **not** need a global pi install. +That's it. The first run walks you through onboarding (token → drives → models → launch). -Launch either way: +**From source (contributors):** ```bash -npm link # optional: puts `pagespace` on your PATH +git clone https://github.com/2witstudios/pagespace-cli.git +cd pagespace-cli +npm install +npm link # puts `pagespace` on your PATH pagespace - -# or without linking -node bin/pagespace.mjs ``` ### First run (Cursor-grade onboarding) @@ -179,18 +177,15 @@ pi install -l . ## Install & distribution -- Root package is `private: true` and not published. -- Exposed CLI bin: `pagespace` → `bin/pagespace.mjs`. -- Packaged files include `extensions`, `src`, `skills`, `prompts`, `bin`, `packages`, `README.md`. - -Local distribution options: - ```bash -npm link # put pagespace on PATH locally -npm pack # create a tarball +npm install -g pagespace-cli # global install (recommended) +npx pagespace-cli # one-shot without global install ``` -There is currently no `peerDependencies` section in the root `package.json`; this repo vendors required pi packages via npm workspaces. +- Exposed CLI bin: `pagespace` → `bin/pagespace.mjs`. +- Packaged files: `extensions`, `src`, `skills`, `prompts`, `bin`, `packages`, `README.md`. +- pi packages are vendored in `packages/` and built automatically via `postinstall`. +- No global pi install required. ## Status & pointers diff --git a/package.json b/package.json index 5ac9494..671e5e9 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,6 @@ { "name": "pagespace-cli", "version": "0.0.1", - "private": true, "type": "module", "workspaces": [ "packages/*" @@ -21,6 +20,7 @@ "url": "https://github.com/2witstudios/pagespace-cli/issues" }, "scripts": { + "postinstall": "npm run build", "build": "npm run build -w packages/pi-tui -w packages/pi-ai -w packages/pi-agent-core -w packages/pi-coding-agent", "typecheck": "tsc --noEmit -p .", "lint": "biome check src extensions test", @@ -30,13 +30,15 @@ "check": "npm run typecheck && npm run lint && npm run test", "prepare": "husky" }, + "dependencies": { + "tsx": "^4.19.2" + }, "devDependencies": { "@biomejs/biome": "^1.9.4", "@earendil-works/pi-ai": "workspace:*", "@earendil-works/pi-coding-agent": "workspace:*", "@typescript/native-preview": "7.0.0-dev.20260120.1", "husky": "^9.1.7", - "tsx": "^4.19.2", "typebox": "^1.1.39", "typescript": "^5.9.3" },