CLI for the-grove component library
npm install @the-grove/cliCLI tool for the-grove component library.
bash
npx the-grove add async-button
`$3
`bash
npx the-grove list
`$3
`bash
npx the-grove contribute ./components/my-component.tsx
`Shadcn Compatibility
the-grove registry is fully compatible with shadcn's CLI! You can use either:
the-grove CLI (recommended for ease of use):
`bash
npx the-grove add async-button
`shadcn CLI (if you prefer):
`bash
npx shadcn@latest add https://raw.githubusercontent.com/matthewnaples/the-grove/main/packages/registry/registry/core/async-button.json
`$3
- Automatic component discovery (no need to know category)
- Stack detection (warns about missing Convex/Clerk dependencies)
- Browse components with
the-grove list
- Same reliable installation (uses shadcn under the hood)Commands
$3
Add components to your project.
`bash
npx the-grove add [options]Options:
-p, --path Custom installation path
-y, --yes Skip confirmation prompts
`$3
List all available components.
`bash
npx the-grove list [options]Options:
-c, --category Filter by category
-t, --tag Filter by tag
`$3
Contribute components back to the-grove.
`bash
npx the-grove contribute
`Requires GITHUB_TOKEN environment variable or will prompt for token.
Development
$3
From the repository root:
`bash
Setup local development environment
npm run dev:linkTest the CLI
the-grove add async-button
the-grove listWatch for changes (in separate terminal)
cd packages/cli
npm run devCleanup when done
cd ../..
npm run dev:unlink
`$3
If you prefer to link manually:
`bash
cd packages/cliBuild
npm run buildLink globally
npm linkTest
the-grove --helpUnlink when done
npm unlink -g @the-grove/cli
`$3
`bash
From repository root
./scripts/test-local.sh add async-button
`$3
For active development with auto-rebuild on file changes:
`bash
npm run dev
``This runs tsup in watch mode - any changes to source files will automatically rebuild the dist folder.