@picked/cli 0.0.101-next.2 → 0.0.101-next.3

package/README.md

@@ -1,22 +1,40 @@
 # @picked/cli
 
-Command-line interface for Picked tooling.
+The `picked` command: sign in, choose a workspace, generate types, move workspaces between
+projects, and read the documentation.
 
-## Commands
+## Install
 
 ```bash
-picked generate types          # Generate TypeScript types from picked.config.ts
-picked generate types --check  # CI mode: fail when types are out of date
+npm install picked
 ```
 
-## Configuration
+`picked` puts the command on your path. Install `@picked/cli` on its own only for the command
+without the SDK.
 
-Commands read `picked.config.ts` from the current working directory. See [Type Generation](https://docs.picked.app/reference/sdk/type-generation) for config options.
-
-## Development
-
-This package is part of the Picked monorepo. Run tests from the repo root:
+## Usage
 
 ```bash
-pnpm run test
+picked login                     # Sign in through the browser
+picked logout
+picked whoami
+picked status
+picked workspace list [--json]
+picked use [--project <id>] [--workspace <id>] [--no-generate]
+picked workspace export --project <id> (--workspace <id> | --live) --out <dir>
+picked workspace import --project <id> --in <dir> [--name <name>] [--publish]
+picked generate types [--check]
+picked docs list [words] [--type <type>] [--json]
+picked docs read <path>
 ```
+
+Commands read `picked.config.ts` from the current directory. `picked workspace use` is an
+alias of `picked use`. Set `PICKED_API_KEY` to run the workspace commands without
+`picked login`.
+
+## Docs
+
+- **Web:** [CLI](https://docs.picked.app/reference/tools/cli)
+- **Local:** `node_modules/picked/docs/reference/tools/cli.md`. The `picked` package carries every page under `node_modules/picked/docs/`.
+- **CLI:** `npx picked docs read /reference/tools/cli`. `npx picked docs list [words]` lists the pages.
+- **MCP:** call `read_picked_doc` with `{ "path": "/reference/tools/cli" }`; `list_picked_docs` lists the pages. Add the server with `claude mcp add --transport http picked https://api.picked.app/mcp`, or see [How to connect the MCP server](https://docs.picked.app/how-to/connect-the-mcp-server) for other tools.