regpick 0.2.9 → 0.2.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -80
- package/package.json +5 -1
package/README.md
CHANGED
|
@@ -3,91 +3,16 @@
|
|
|
3
3
|
[](https://www.npmjs.com/package/regpick)
|
|
4
4
|
[](https://opensource.org/licenses/MIT)
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
A powerful, lightweight CLI tool to browse, select, and install components from any shadcn-compatible registry. Zero configuration required.
|
|
7
7
|
|
|
8
|
-
##
|
|
8
|
+
## Documentation
|
|
9
9
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
- **Smart Updates**: Keep track of installed components via `regpick-lock.json` and update them interactively with built-in diff viewing.
|
|
13
|
-
- **Dependency Management**: Automatically detects and prompts to install missing `dependencies` and `devDependencies`.
|
|
14
|
-
- **Registry Aliases**: Configure shortcuts for your frequently used registries.
|
|
15
|
-
- **Component Packing**: Easily turn your local components into a distributable `registry.json`.
|
|
10
|
+
Full documentation, guides, and configuration references are available at:
|
|
11
|
+
**👉 [https://regpick.vercel.app/](https://regpick.vercel.app/)**
|
|
16
12
|
|
|
17
13
|
## Quick Start
|
|
18
14
|
|
|
19
|
-
The easiest way to use `regpick` is via `npx` or your preferred package runner.
|
|
20
|
-
|
|
21
15
|
```bash
|
|
22
|
-
# Initialize configuration in your project
|
|
23
16
|
npx regpick init
|
|
17
|
+
npx regpick add <registry-url>
|
|
24
18
|
```
|
|
25
|
-
|
|
26
|
-
## Use Cases
|
|
27
|
-
|
|
28
|
-
`regpick` adapts to your workflow, whether you are exploring components manually or automating your CI/CD.
|
|
29
|
-
|
|
30
|
-
### 1. Interactive Component Addition
|
|
31
|
-
Browse and select components to install interactively.
|
|
32
|
-
```bash
|
|
33
|
-
npx regpick add <registry-url-or-alias>
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
### 2. Check Available Components
|
|
37
|
-
List all items available in a registry before adding them.
|
|
38
|
-
```bash
|
|
39
|
-
npx regpick list <registry-url-or-alias>
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
### 3. Keep Components Up-to-Date
|
|
43
|
-
Check for upstream updates to your installed components and review code diffs before applying changes.
|
|
44
|
-
```bash
|
|
45
|
-
npx regpick update
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
### 4. Create Your Own Registry
|
|
49
|
-
Scan a local directory of components and pack them into a distributable `registry.json`.
|
|
50
|
-
```bash
|
|
51
|
-
npx regpick pack ./src/components/ui
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
## CLI Flags & Automation
|
|
55
|
-
|
|
56
|
-
You can run `regpick` in a non-interactive or scriptable way using CLI flags:
|
|
57
|
-
|
|
58
|
-
- `--cwd=<path>`: Change the working directory (useful in monorepos).
|
|
59
|
-
- `--yes`: Skip confirmation prompts (e.g., dependency installation, overwrite confirmation). Assumes "yes" or default configuration.
|
|
60
|
-
- `--all`: Select all items available in the registry during the `add` command.
|
|
61
|
-
- `--select=a,b,c`: Comma-separated list of items to explicitly select without showing the interactive menu.
|
|
62
|
-
|
|
63
|
-
## Configuration
|
|
64
|
-
|
|
65
|
-
`regpick` uses a configuration file (e.g., `regpick.config.json` or `regpick.json`) at the root of your project. You can generate this by running `regpick init`.
|
|
66
|
-
|
|
67
|
-
<details>
|
|
68
|
-
<summary>Click to view a basic configuration example</summary>
|
|
69
|
-
|
|
70
|
-
```json
|
|
71
|
-
{
|
|
72
|
-
"registries": {
|
|
73
|
-
"ui": "https://ui.shadcn.com/r"
|
|
74
|
-
},
|
|
75
|
-
"targetsByType": {
|
|
76
|
-
"registry:component": "src/components/ui"
|
|
77
|
-
},
|
|
78
|
-
"overwritePolicy": "prompt",
|
|
79
|
-
"packageManager": "auto"
|
|
80
|
-
}
|
|
81
|
-
```
|
|
82
|
-
|
|
83
|
-
</details>
|
|
84
|
-
|
|
85
|
-
For a full list of configuration options, including advanced settings like import aliases (`aliases`) and security policies (`allowOutsideProject`), please see the [Configuration Reference](./docs/CONFIGURATION_REFERENCE.md).
|
|
86
|
-
|
|
87
|
-
## Lockfile (`regpick-lock.json`)
|
|
88
|
-
|
|
89
|
-
When you install components, `regpick` generates a lockfile to track the source and content hash of each installed item. This allows the `update` command to detect upstream changes and offer interactive updates with diff viewing.
|
|
90
|
-
|
|
91
|
-
---
|
|
92
|
-
|
|
93
|
-
For a detailed behavioral breakdown of every command (Success & Error stories), see the [Command Stories Documentation](./docs/COMMANDS_STORIES.md).
|
package/package.json
CHANGED
|
@@ -1,8 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "regpick",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.11",
|
|
4
4
|
"description": "Lightweight CLI for selecting and installing registry entries.",
|
|
5
5
|
"type": "module",
|
|
6
|
+
"main": "./dist/index.mjs",
|
|
7
|
+
"exports": {
|
|
8
|
+
".": "./dist/index.mjs"
|
|
9
|
+
},
|
|
6
10
|
"files": [
|
|
7
11
|
"dist",
|
|
8
12
|
"bin",
|