@picked/config 0.0.1-dev.1788925875333 → 0.0.1-dev.1793753513002

package/LICENSE

@@ -0,0 +1 @@
+Copyright (c) Picked. All rights reserved. Contact Picked for a usage licence.

package/README.md

@@ -1,26 +1,39 @@
 # @picked/config
 
-Shared configuration and artefact helpers for Picked tooling packages (`@picked/vite-plugin-picked`, `@picked/typegen`, `@picked/cli`).
+`defineConfig` and the loaders for `picked.config.ts`, the file the CLI, the type generator
+and the Vite plugin read your project from.
 
-## Configuration
+## Install
+
+```bash
+npm install picked
+```
+
+`picked/config` re-exports this package.
+
+## Usage
 
 ```typescript
-import { defineConfig } from '@picked/config'
+// picked.config.ts
+import { defineConfig } from 'picked/config'
 
 export default defineConfig({
   projectId: 'your-project-id',
-  apiUrl: 'https://api.picked.app',
-  typesOutput: './src/picked-env.d.ts',
-  source: 'published',
 })
 ```
 
-See [Type Generation](https://docs.picked.app/reference/sdk/type-generation) for option details.
-
-## Development
-
-This package is part of the Picked monorepo. Run tests from the repo root:
-
-```bash
-pnpm run test
-```
+| Option         | Default                    | Description                                                                                         |
+| -------------- | -------------------------- | --------------------------------------------------------------------------------------------------- |
+| `projectId`    | required                   | The Picked project.                                                                                 |
+| `apiUrl`       | `'https://api.picked.app'` | The Picked API origin.                                                                              |
+| `typesOutput`  | `'./src/picked-env.d.ts'`  | Where generated types are written.                                                                  |
+| `source`       | `'published'`              | Generate types from the published schema, or `'preview'` for a workspace draft.                     |
+| `previewToken` | none                       | The workspace preview token; required when `source` is `'preview'`. Keep it out of version control. |
+| `telemetry`    | `false`                    | Send anonymous usage telemetry from the CLI and the Vite plugin.                                    |
+
+## Docs
+
+- **Web:** [Type Generation](https://docs.picked.app/reference/sdk/type-generation)
+- **Local:** `node_modules/picked/docs/reference/sdk/type-generation.md`. The `picked` package carries every page under `node_modules/picked/docs/`.
+- **CLI:** `npx picked docs read /reference/sdk/type-generation`. `npx picked docs list [words]` lists the pages.
+- **MCP:** call `read_picked_doc` with `{ "path": "/reference/sdk/type-generation" }`; `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.