@deessejs/cli 2.3.0 → 3.0.0
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 +26 -7
- package/dist/index.js +881 -208
- package/dist/index.js.map +1 -1
- package/package.json +12 -7
package/README.md
CHANGED
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
CLI for the DeesseJS template registry and block sources.
|
|
4
4
|
|
|
5
|
+
Requires Node.js 22.14 or later.
|
|
6
|
+
|
|
5
7
|
## Install
|
|
6
8
|
|
|
7
9
|
The package is published as `@deessejs/cli` and exposes the `deessejs` executable:
|
|
@@ -17,13 +19,16 @@ Other release channels:
|
|
|
17
19
|
|
|
18
20
|
## Commands
|
|
19
21
|
|
|
20
|
-
| Command
|
|
21
|
-
|
|
|
22
|
-
| `deessejs init <slug-or-github-url>`
|
|
23
|
-
| `deessejs list`
|
|
24
|
-
| `deessejs info <slug-or-github-url>`
|
|
25
|
-
| `deessejs block info <source>`
|
|
26
|
-
| `deessejs block check [source]`
|
|
22
|
+
| Command | Role |
|
|
23
|
+
| ------------------------------------- | --------------------------------------------------------------- |
|
|
24
|
+
| `deessejs init <slug-or-github-url>` | Create a project from a catalog template or a GitHub repository |
|
|
25
|
+
| `deessejs list` | List available templates |
|
|
26
|
+
| `deessejs info <slug-or-github-url>` | Show validated descriptor details for a template |
|
|
27
|
+
| `deessejs block info <source>` | Show a validated block descriptor summary |
|
|
28
|
+
| `deessejs block check [source]` | Validate a block descriptor and its referenced assets |
|
|
29
|
+
| `deessejs organization list` | List organizations the signed-in user belongs to |
|
|
30
|
+
| `deessejs organization info <slug>` | Show one of the signed-in user's organizations |
|
|
31
|
+
| `deessejs organization create <name>` | Create an organization |
|
|
27
32
|
|
|
28
33
|
## Examples
|
|
29
34
|
|
|
@@ -40,16 +45,30 @@ deessejs init saas-starter
|
|
|
40
45
|
deessejs init saas-starter --ref develop --no-install
|
|
41
46
|
deessejs init https://github.com/owner/repository
|
|
42
47
|
deessejs init saas-starter --verbose
|
|
48
|
+
deessejs auth login
|
|
49
|
+
deessejs organization list
|
|
50
|
+
deessejs organization info acme
|
|
51
|
+
deessejs organization create "Acme Studio"
|
|
52
|
+
deessejs organization list --json
|
|
53
|
+
deessejs organization template list acme --json
|
|
54
|
+
deessejs organization template info acme starter-kit
|
|
55
|
+
deessejs organization template add acme --slug starter-kit --name "Starter Kit" --repository https://github.com/acme/starter-kit --category saas
|
|
43
56
|
```
|
|
44
57
|
|
|
45
58
|
`init` accepts a catalog slug or an HTTPS URL to a GitHub repository root. Both forms use the repository's root `deesse-template.json` to select the files to create. The descriptor must be present and valid; there is no Git clone fallback. `--ref` selects a branch or other Git ref. `--force` allows an existing empty target directory; it never removes existing files.
|
|
46
59
|
|
|
60
|
+
If the selected files include a root `deesse.json`, `init` validates it against project config V1 and preserves its contents. If the template does not include one, `init` creates a default config with the project schema URL and `formatVersion: 1`.
|
|
61
|
+
|
|
47
62
|
`info` accepts a catalog slug or GitHub repository URL and shows the same descriptor fields for both. Slugs are mapped to repositories through a lightweight catalog lookup; `info` does not fetch the GitHub-enriched listing. It then reads only the root `deesse-template.json` through GitHub's Contents API, without downloading or inventorying the full repository. `--ref` inspects a specific branch or other Git ref. With `--json`, the result contains the validated `descriptor` and source repository.
|
|
48
63
|
|
|
49
64
|
`block info` accepts a local block directory, a public HTTPS GitHub repository URL, a shorthand GitHub directory URL such as `https://github.com/owner/repository/block`, or a canonical `/tree/<ref>/<block-path>` URL. It resolves a remote ref to a commit before reading the root `deesse-block.json` and the package manifests declared by its file mappings. It does not modify a project, install dependencies or execute package scripts. `--json` returns the descriptor, package summaries and source identity.
|
|
50
65
|
|
|
51
66
|
`block check` accepts the same local and GitHub sources and defaults to the current directory when no source is given. It validates the descriptor and reads every file declared in `install.files`, including package manifests. It reports all unreadable assets without writing to the project, installing dependencies or executing package scripts. It does not yet plan changes against a receiving project. Use `--json` for stable diagnostic codes and source paths.
|
|
52
67
|
|
|
68
|
+
Organization commands require an active session from `deessejs auth login`. `list` and `info` use Better Auth's authenticated organization endpoints and only show organizations the caller belongs to. `create` proposes a slug from the name, then sends the name and slug through DeesseJS's authenticated provisioning API. The server validates the slug, resolves collisions and returns the stored slug. Creating an organization does not change the active organization. Each command accepts `--json` for scripting.
|
|
69
|
+
|
|
70
|
+
`organization template list <organization-slug>` lists all templates owned by that organization that the signed-in user can access, including templates that have not been submitted for publication. `info <organization-slug> <template-slug>` shows one owned template. Both expose review and publication state independently from organization ownership. `add <organization-slug>` requires `--slug`, `--name`, `--repository` and `--category`; optional metadata uses `--description`, repeatable `--label` (repeat the option for each label) and `--license`. The API validates the public GitHub repository and requires an organization owner or admin. Adding a template creates an organization-owned entry; it does not publish it. Use `--json` for scripting.
|
|
71
|
+
|
|
53
72
|
By default, `init` hides package manager logs and shows a concise progress summary. Pass `--verbose` to print the resolved template source, ref, destination, commit, and selected file count, as well as the full package manager output when installation runs. Verbose details go to stderr so `--json` keeps stdout machine-readable. The details are also shown with `--no-install`.
|
|
54
73
|
|
|
55
74
|
## Global flags
|