@riebeckite/cli 0.0.12 → 0.0.13
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 +71 -71
- package/README_ja.md +62 -62
- package/assets/favicon.ico +0 -0
- package/assets/riebeckite-logo.png +0 -0
- package/dist/cli.js +306 -272
- package/package.json +4 -3
package/README.md
CHANGED
|
@@ -1,71 +1,71 @@
|
|
|
1
|
-
# @riebeckite/cli
|
|
2
|
-
|
|
3
|
-
The Riebeckite command-line interface: Node.js build-time tooling for
|
|
4
|
-
validating a project, diagnosing it, inspecting resolved state, and building
|
|
5
|
-
the site.
|
|
6
|
-
|
|
7
|
-
[日本語](./README_ja.md)
|
|
8
|
-
|
|
9
|
-
## Overview
|
|
10
|
-
|
|
11
|
-
`@riebeckite/cli` provides the `riebeckite` binary. It resolves the application
|
|
12
|
-
root from the current working directory and reports command failures safely with
|
|
13
|
-
a non-zero exit code. `check`, `doctor`, `inspect`, and `profile` are read-only;
|
|
14
|
-
only `build` and `dev` mutate output or start a server.
|
|
15
|
-
|
|
16
|
-
## Installation
|
|
17
|
-
|
|
18
|
-
```sh
|
|
19
|
-
pnpm add -D @riebeckite/cli
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
The package exposes only the binary (`bin/riebeckite.mjs`); it has no library
|
|
23
|
-
entry point.
|
|
24
|
-
|
|
25
|
-
```sh
|
|
26
|
-
npx @riebeckite/cli check
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
In a pnpm project, use `pnpm exec riebeckite`.
|
|
30
|
-
|
|
31
|
-
## Usage
|
|
32
|
-
|
|
33
|
-
```text
|
|
34
|
-
riebeckite dev
|
|
35
|
-
riebeckite check
|
|
36
|
-
riebeckite doctor
|
|
37
|
-
riebeckite build [--full]
|
|
38
|
-
riebeckite profile [--full]
|
|
39
|
-
riebeckite inspect [config | plugins | content [--list] | graph | build]
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
## Commands
|
|
43
|
-
|
|
44
|
-
| Command | Purpose | Writes build state? |
|
|
45
|
-
| --- | --- | --- |
|
|
46
|
-
| `dev` | Start the integration development workflow | integration-dependent |
|
|
47
|
-
| `check` | Validate app configuration, plugins, and capability resolution | no |
|
|
48
|
-
| `doctor` | Diagnose environment, configuration, plugins, content, diagnostics, and build state | no |
|
|
49
|
-
| `build` | Run the build path; `--full` bypasses incremental reuse | yes, on success |
|
|
50
|
-
| `profile` | Run tracing-based performance reporting; `--full` uses a full path | build-dependent |
|
|
51
|
-
| `inspect` | Display factual resolved state (`config`, `plugins`, `content`, `graph`, `build`) | no |
|
|
52
|
-
|
|
53
|
-
`doctor` continues independent checks where possible and exits unsuccessfully
|
|
54
|
-
when health checks fail. `inspect` is deliberately read-only and never triggers
|
|
55
|
-
a build or writes state. See [Diagnostics](../../docs/en/diagnostics.md) and
|
|
56
|
-
[Framework Inspector](../../docs/en/inspector.md) for how to interpret output.
|
|
57
|
-
|
|
58
|
-
## Typical workflow
|
|
59
|
-
|
|
60
|
-
```sh
|
|
61
|
-
pnpm exec riebeckite check
|
|
62
|
-
pnpm exec riebeckite doctor
|
|
63
|
-
pnpm exec riebeckite inspect plugins
|
|
64
|
-
pnpm exec riebeckite build
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
## See also
|
|
68
|
-
|
|
69
|
-
- [CLI Reference](../../docs/en/cli.md)
|
|
70
|
-
- [Build System](../../docs/en/build-system.md)
|
|
71
|
-
- [Diagnostics](../../docs/en/diagnostics.md) / [Framework Inspector](../../docs/en/inspector.md)
|
|
1
|
+
# @riebeckite/cli
|
|
2
|
+
|
|
3
|
+
The Riebeckite command-line interface: Node.js build-time tooling for
|
|
4
|
+
validating a project, diagnosing it, inspecting resolved state, and building
|
|
5
|
+
the site.
|
|
6
|
+
|
|
7
|
+
[日本語](./README_ja.md)
|
|
8
|
+
|
|
9
|
+
## Overview
|
|
10
|
+
|
|
11
|
+
`@riebeckite/cli` provides the `riebeckite` binary. It resolves the application
|
|
12
|
+
root from the current working directory and reports command failures safely with
|
|
13
|
+
a non-zero exit code. `check`, `doctor`, `inspect`, and `profile` are read-only;
|
|
14
|
+
only `build` and `dev` mutate output or start a server.
|
|
15
|
+
|
|
16
|
+
## Installation
|
|
17
|
+
|
|
18
|
+
```sh
|
|
19
|
+
pnpm add -D @riebeckite/cli
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
The package exposes only the binary (`bin/riebeckite.mjs`); it has no library
|
|
23
|
+
entry point.
|
|
24
|
+
|
|
25
|
+
```sh
|
|
26
|
+
npx @riebeckite/cli check
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
In a pnpm project, use `pnpm exec riebeckite`.
|
|
30
|
+
|
|
31
|
+
## Usage
|
|
32
|
+
|
|
33
|
+
```text
|
|
34
|
+
riebeckite dev
|
|
35
|
+
riebeckite check
|
|
36
|
+
riebeckite doctor
|
|
37
|
+
riebeckite build [--full]
|
|
38
|
+
riebeckite profile [--full]
|
|
39
|
+
riebeckite inspect [config | plugins | content [--list] | graph | build]
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Commands
|
|
43
|
+
|
|
44
|
+
| Command | Purpose | Writes build state? |
|
|
45
|
+
| --- | --- | --- |
|
|
46
|
+
| `dev` | Start the integration development workflow | integration-dependent |
|
|
47
|
+
| `check` | Validate app configuration, plugins, and capability resolution | no |
|
|
48
|
+
| `doctor` | Diagnose environment, configuration, plugins, content, diagnostics, and build state | no |
|
|
49
|
+
| `build` | Run the build path; `--full` bypasses incremental reuse | yes, on success |
|
|
50
|
+
| `profile` | Run tracing-based performance reporting; `--full` uses a full path | build-dependent |
|
|
51
|
+
| `inspect` | Display factual resolved state (`config`, `plugins`, `content`, `graph`, `build`) | no |
|
|
52
|
+
|
|
53
|
+
`doctor` continues independent checks where possible and exits unsuccessfully
|
|
54
|
+
when health checks fail. `inspect` is deliberately read-only and never triggers
|
|
55
|
+
a build or writes state. See [Diagnostics](../../docs/en/framework/diagnostics.md) and
|
|
56
|
+
[Framework Inspector](../../docs/en/framework/inspector.md) for how to interpret output.
|
|
57
|
+
|
|
58
|
+
## Typical workflow
|
|
59
|
+
|
|
60
|
+
```sh
|
|
61
|
+
pnpm exec riebeckite check
|
|
62
|
+
pnpm exec riebeckite doctor
|
|
63
|
+
pnpm exec riebeckite inspect plugins
|
|
64
|
+
pnpm exec riebeckite build
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## See also
|
|
68
|
+
|
|
69
|
+
- [CLI Reference](../../docs/en/reference/cli.md)
|
|
70
|
+
- [Build System](../../docs/en/framework/build-system.md)
|
|
71
|
+
- [Diagnostics](../../docs/en/framework/diagnostics.md) / [Framework Inspector](../../docs/en/framework/inspector.md)
|
package/README_ja.md
CHANGED
|
@@ -1,62 +1,62 @@
|
|
|
1
|
-
# @riebeckite/cli
|
|
2
|
-
|
|
3
|
-
Riebeckite のコマンドラインインターフェースです。プロジェクトの検証・診断・状態の確認・ビルドを行う、Node.js のビルド時ツールを提供します。
|
|
4
|
-
|
|
5
|
-
[English](./README.md)
|
|
6
|
-
|
|
7
|
-
## 概要
|
|
8
|
-
|
|
9
|
-
`@riebeckite/cli` は `riebeckite` バイナリを提供します。カレントディレクトリからアプリケーションルートを解決し、コマンドの失敗は非ゼロの終了コードで安全に報告します。`check`、`doctor`、`inspect`、`profile` は読み取り専用で、出力を書き換えたりサーバーを起動するのは `build` と `dev` だけです。
|
|
10
|
-
|
|
11
|
-
## インストール
|
|
12
|
-
|
|
13
|
-
```sh
|
|
14
|
-
pnpm add -D @riebeckite/cli
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
このパッケージはバイナリ(`bin/riebeckite.mjs`)のみを公開し、ライブラリのエントリポイントは持ちません。
|
|
18
|
-
|
|
19
|
-
```sh
|
|
20
|
-
npx @riebeckite/cli check
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
pnpm のプロジェクトでは `pnpm exec riebeckite` で実行します。
|
|
24
|
-
|
|
25
|
-
## 使い方
|
|
26
|
-
|
|
27
|
-
```text
|
|
28
|
-
riebeckite dev
|
|
29
|
-
riebeckite check
|
|
30
|
-
riebeckite doctor
|
|
31
|
-
riebeckite build [--full]
|
|
32
|
-
riebeckite profile [--full]
|
|
33
|
-
riebeckite inspect [config | plugins | content [--list] | graph | build]
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
## コマンド
|
|
37
|
-
|
|
38
|
-
| コマンド | 目的 | ビルド状態を書くか |
|
|
39
|
-
| --- | --- | --- |
|
|
40
|
-
| `dev` | integration の開発ワークフローを起動する | integration による |
|
|
41
|
-
| `check` | アプリの設定、Plugin、capability の解決を検証する | いいえ |
|
|
42
|
-
| `doctor` | 環境、設定、Plugin、コンテンツ、診断、ビルド状態を診断する | いいえ |
|
|
43
|
-
| `build` | ビルドを実行する。`--full` は差分の再利用を行わない | 成功時に書く |
|
|
44
|
-
| `profile` | トレースに基づく性能レポートを実行する。`--full` は全体を対象にする | ビルドの実行による |
|
|
45
|
-
| `inspect` | 解決済みの状態を事実として表示する(`config`、`plugins`、`content`、`graph`、`build`) | いいえ |
|
|
46
|
-
|
|
47
|
-
`doctor` は独立したチェックを可能な限り続行し、ヘルスチェックに失敗すると非ゼロで終了します。`inspect` は読み取り専用で、ビルドの実行や状態の書き込みは行いません。出力の読み方は [Diagnostics](../../docs/ja/diagnostics.md) と [Framework Inspector](../../docs/ja/inspector.md) を参照してください。
|
|
48
|
-
|
|
49
|
-
## 典型的な流れ
|
|
50
|
-
|
|
51
|
-
```sh
|
|
52
|
-
pnpm exec riebeckite check
|
|
53
|
-
pnpm exec riebeckite doctor
|
|
54
|
-
pnpm exec riebeckite inspect plugins
|
|
55
|
-
pnpm exec riebeckite build
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
## 関連資料
|
|
59
|
-
|
|
60
|
-
- [CLI Reference](../../docs/ja/cli.md)
|
|
61
|
-
- [Build System](../../docs/ja/build-system.md)
|
|
62
|
-
- [Diagnostics](../../docs/ja/diagnostics.md) / [Framework Inspector](../../docs/ja/inspector.md)
|
|
1
|
+
# @riebeckite/cli
|
|
2
|
+
|
|
3
|
+
Riebeckite のコマンドラインインターフェースです。プロジェクトの検証・診断・状態の確認・ビルドを行う、Node.js のビルド時ツールを提供します。
|
|
4
|
+
|
|
5
|
+
[English](./README.md)
|
|
6
|
+
|
|
7
|
+
## 概要
|
|
8
|
+
|
|
9
|
+
`@riebeckite/cli` は `riebeckite` バイナリを提供します。カレントディレクトリからアプリケーションルートを解決し、コマンドの失敗は非ゼロの終了コードで安全に報告します。`check`、`doctor`、`inspect`、`profile` は読み取り専用で、出力を書き換えたりサーバーを起動するのは `build` と `dev` だけです。
|
|
10
|
+
|
|
11
|
+
## インストール
|
|
12
|
+
|
|
13
|
+
```sh
|
|
14
|
+
pnpm add -D @riebeckite/cli
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
このパッケージはバイナリ(`bin/riebeckite.mjs`)のみを公開し、ライブラリのエントリポイントは持ちません。
|
|
18
|
+
|
|
19
|
+
```sh
|
|
20
|
+
npx @riebeckite/cli check
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
pnpm のプロジェクトでは `pnpm exec riebeckite` で実行します。
|
|
24
|
+
|
|
25
|
+
## 使い方
|
|
26
|
+
|
|
27
|
+
```text
|
|
28
|
+
riebeckite dev
|
|
29
|
+
riebeckite check
|
|
30
|
+
riebeckite doctor
|
|
31
|
+
riebeckite build [--full]
|
|
32
|
+
riebeckite profile [--full]
|
|
33
|
+
riebeckite inspect [config | plugins | content [--list] | graph | build]
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## コマンド
|
|
37
|
+
|
|
38
|
+
| コマンド | 目的 | ビルド状態を書くか |
|
|
39
|
+
| --- | --- | --- |
|
|
40
|
+
| `dev` | integration の開発ワークフローを起動する | integration による |
|
|
41
|
+
| `check` | アプリの設定、Plugin、capability の解決を検証する | いいえ |
|
|
42
|
+
| `doctor` | 環境、設定、Plugin、コンテンツ、診断、ビルド状態を診断する | いいえ |
|
|
43
|
+
| `build` | ビルドを実行する。`--full` は差分の再利用を行わない | 成功時に書く |
|
|
44
|
+
| `profile` | トレースに基づく性能レポートを実行する。`--full` は全体を対象にする | ビルドの実行による |
|
|
45
|
+
| `inspect` | 解決済みの状態を事実として表示する(`config`、`plugins`、`content`、`graph`、`build`) | いいえ |
|
|
46
|
+
|
|
47
|
+
`doctor` は独立したチェックを可能な限り続行し、ヘルスチェックに失敗すると非ゼロで終了します。`inspect` は読み取り専用で、ビルドの実行や状態の書き込みは行いません。出力の読み方は [Diagnostics](../../docs/ja/framework/diagnostics.md) と [Framework Inspector](../../docs/ja/framework/inspector.md) を参照してください。
|
|
48
|
+
|
|
49
|
+
## 典型的な流れ
|
|
50
|
+
|
|
51
|
+
```sh
|
|
52
|
+
pnpm exec riebeckite check
|
|
53
|
+
pnpm exec riebeckite doctor
|
|
54
|
+
pnpm exec riebeckite inspect plugins
|
|
55
|
+
pnpm exec riebeckite build
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## 関連資料
|
|
59
|
+
|
|
60
|
+
- [CLI Reference](../../docs/ja/reference/cli.md)
|
|
61
|
+
- [Build System](../../docs/ja/framework/build-system.md)
|
|
62
|
+
- [Diagnostics](../../docs/ja/framework/diagnostics.md) / [Framework Inspector](../../docs/ja/framework/inspector.md)
|
|
Binary file
|
|
Binary file
|