@foundrykit/cli 2.0.11 → 2.0.12

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.
@@ -1,4 +1,4 @@
1
1
 
2
- > @foundrykit/cli@2.0.10 type-check /Users/isj/Desktop/work/projects/foundry/packages/cli
2
+ > @foundrykit/cli@2.0.12 type-check /home/runner/work/foundry/foundry/packages/cli
3
3
  > tsc --noEmit
4
4
 
package/CHANGELOG.md CHANGED
@@ -1,5 +1,14 @@
1
1
  # @foundrykit/cli
2
2
 
3
+ ## 2.0.12
4
+
5
+ ### Patch Changes
6
+
7
+ - [#43](https://github.com/umi-labs/foundry/pull/43) [`b6fc94d`](https://github.com/umi-labs/foundry/commit/b6fc94d3b0f172aa309388f61bd5306af6405fdf) Thanks [@sneddonisaac](https://github.com/sneddonisaac)! - Package metadata now points at the `umi-labs/foundry` monorepo, and releases publish through npm trusted publishing.
8
+
9
+ - Updated dependencies [[`b6fc94d`](https://github.com/umi-labs/foundry/commit/b6fc94d3b0f172aa309388f61bd5306af6405fdf)]:
10
+ - @foundrykit/types@2.0.7
11
+
3
12
  ## 2.0.11
4
13
 
5
14
  ### Patch Changes
package/README.md CHANGED
@@ -1,75 +1,77 @@
1
1
  # @foundrykit/cli
2
2
 
3
- The FoundryKit CLI initializes projects and installs components from the
4
- FoundryKit registry.
3
+ Command-line tool for initializing FoundryKit in a project and installing
4
+ components from the FoundryKit registry. Exposes the `foundrykit` binary.
5
+
6
+ ## Installation
7
+
8
+ Run directly with your package runner:
9
+
10
+ ```bash
11
+ npx @foundrykit/cli init
12
+ # or
13
+ pnpm dlx @foundrykit/cli init
14
+ ```
15
+
16
+ Or install it as a dev dependency:
17
+
18
+ ```bash
19
+ pnpm add -D @foundrykit/cli
20
+ ```
5
21
 
6
22
  ## Commands
7
23
 
8
24
  ### `init`
9
25
 
10
- Creates `foundrykit.config.json`, installs the utility helper, prepares target
11
- directories, and updates package scripts for a Next.js project.
26
+ Scaffolds `foundrykit.config.json`, installs the utility helper, prepares target
27
+ directories, and updates package scripts.
12
28
 
13
29
  ```bash
14
- foundrykit init
30
+ foundrykit init [--force] [--skip-install] [--skip-prompts]
15
31
  ```
16
32
 
17
33
  ### `list`
18
34
 
19
- Lists available registry components.
35
+ Lists available registry components and blocks.
20
36
 
21
37
  ```bash
22
38
  foundrykit list
23
- foundrykit list -c primitives
24
- foundrykit list -s button
39
+ foundrykit list -c primitives # filter by category
40
+ foundrykit list -s button # search by name/description
25
41
  ```
26
42
 
27
43
  ### `add`
28
44
 
29
- Fetches a component from the registry, installs its files, installs any missing
30
- package dependencies, and prints a usage hint.
45
+ Fetches a component or block from the registry, installs its files and any
46
+ missing dependencies. Runs interactively when no id is given.
31
47
 
32
48
  ```bash
33
- foundrykit add hero-minimal
34
- foundrykit add button -o
49
+ foundrykit add [id] [--with-animation] [-p <path>] [-o]
35
50
  ```
36
51
 
37
52
  ### `update`
38
53
 
39
- Reinstalls a component with overwrite semantics using the same registry-backed
40
- installation flow as `add`.
54
+ Reinstalls installed components (omit the id to update all).
41
55
 
42
56
  ```bash
43
- foundrykit update hero-minimal
57
+ foundrykit update [id] [-o] [-f] [-p <path>]
44
58
  ```
45
59
 
46
60
  ### `doctor`
47
61
 
48
- Validates that:
49
-
50
- - `package.json` exists
51
- - Next.js is detected
52
- - `foundrykit.config.json` exists and has the expected shape
53
- - the configured registry URL is reachable
62
+ Checks project health: `package.json`, Next.js detection, a valid
63
+ `foundrykit.config.json`, and registry reachability.
54
64
 
55
65
  ```bash
56
66
  foundrykit doctor
57
67
  ```
58
68
 
59
- ## Registry Contract
60
-
61
- The CLI uses the registry configured in `foundrykit.config.json`.
62
-
63
- Canonical endpoints:
64
-
65
- - `GET {registry}/registry`
66
- - `GET {registry}/registry/{id}`
67
-
68
- Legacy `/api/components` endpoints may still exist on the host for
69
- compatibility, but the CLI should be considered a `/registry` consumer.
70
-
71
69
  ## Notes
72
70
 
73
71
  - The CLI currently targets Next.js projects.
74
- - `test` runs in non-watch mode by default for CI friendliness.
75
- - Installation paths are controlled by `foundrykit.config.json`.
72
+ - Installation paths and the registry URL are controlled by
73
+ `foundrykit.config.json`.
74
+
75
+ ## License
76
+
77
+ MIT