@teambit/harmony.content.cli-reference 2.0.1003 → 2.0.1005

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
- description: 'Bit command synopses. Bit version: 1.13.140'
2
+ description: 'Bit command synopses. Bit version: 1.13.142'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
@@ -1857,6 +1857,11 @@
1857
1857
  "c",
1858
1858
  "current-dir",
1859
1859
  "create the new workspace in current directory (default is to create a new directory, inside the current dir)"
1860
+ ],
1861
+ [
1862
+ "",
1863
+ "agent [type]",
1864
+ "create an AI agent instructions file. options: claude, cursor, copilot (default: AGENTS.md)"
1860
1865
  ]
1861
1866
  ],
1862
1867
  "description": "create a new Bit workspace from a template",
@@ -3730,10 +3735,40 @@
3730
3735
  "t",
3731
3736
  "table",
3732
3737
  "show tables instead of plain text for dependencies diff"
3738
+ ],
3739
+ [
3740
+ "",
3741
+ "file <paths>",
3742
+ "show only file diffs for the given component-relative path(s). comma-separated. implies --files-only"
3743
+ ],
3744
+ [
3745
+ "",
3746
+ "files-only",
3747
+ "show only file-content diffs; omit dependency, env, and aspect-config changes"
3748
+ ],
3749
+ [
3750
+ "",
3751
+ "configs-only",
3752
+ "show only dependency, env, and aspect-config changes; omit file-content diffs"
3753
+ ],
3754
+ [
3755
+ "",
3756
+ "name-only",
3757
+ "summary: list changed files with status (M/A/D) and changed field categories; no diff bodies"
3758
+ ],
3759
+ [
3760
+ "",
3761
+ "stat",
3762
+ "summary: like --name-only but includes +N -M line counts per file"
3763
+ ],
3764
+ [
3765
+ "j",
3766
+ "json",
3767
+ "return the diff result as json"
3733
3768
  ]
3734
3769
  ],
3735
3770
  "description": "compare component changes between versions or against the current workspace",
3736
- "extendedDescription": "shows a detailed diff of component files, dependencies, and configuration changes. \nby default, compares workspace changes against the latest version. specify versions to compare historical changes.\nsupports pattern matching to filter components and various output formats for better readability.",
3771
+ "extendedDescription": "shows a detailed diff of component files, dependencies, and configuration changes.\nby default, compares workspace changes against the latest version. specify versions to compare historical changes.\nsupports pattern matching to filter components and various output formats for better readability.\nfor ai-agent workflows, use --name-only to list what changed, --file to drill into a specific file,\n--files-only / --configs-only to focus on one diff category, or --json for machine-readable output.",
3737
3772
  "group": "info-analysis",
3738
3773
  "private": false,
3739
3774
  "arguments": [
@@ -3774,6 +3809,22 @@
3774
3809
  {
3775
3810
  "cmd": "diff foo 0.0.2 --parent",
3776
3811
  "description": "compare \"foo@0.0.2\" to its parent version. showing what changed in 0.0.2"
3812
+ },
3813
+ {
3814
+ "cmd": "diff foo --name-only",
3815
+ "description": "list changed files and field categories without diff bodies"
3816
+ },
3817
+ {
3818
+ "cmd": "diff foo --file src/index.ts",
3819
+ "description": "show the diff of a single file in a component"
3820
+ },
3821
+ {
3822
+ "cmd": "diff foo --files-only",
3823
+ "description": "show only source-code diffs, skip dependency/config changes"
3824
+ },
3825
+ {
3826
+ "cmd": "diff foo --json",
3827
+ "description": "return the diff result as json for programmatic consumption"
3777
3828
  }
3778
3829
  ]
3779
3830
  },
@@ -5142,6 +5193,11 @@
5142
5193
  "",
5143
5194
  "skip-interactive",
5144
5195
  "skip interactive mode for Git repositories"
5196
+ ],
5197
+ [
5198
+ "",
5199
+ "agent [type]",
5200
+ "create an AI agent instructions file. options: claude, cursor, copilot (default: AGENTS.md)"
5145
5201
  ]
5146
5202
  ],
5147
5203
  "description": "initialize a Bit workspace in an existing project",
package/cli-reference.mdx CHANGED
@@ -808,7 +808,9 @@ scans node_modules/.pnpm to report actual installed copies, identifies packages
808
808
  **Description**: compare component changes between versions or against the current workspace
809
809
  shows a detailed diff of component files, dependencies, and configuration changes.
810
810
  by default, compares workspace changes against the latest version. specify versions to compare historical changes.
811
- supports pattern matching to filter components and various output formats for better readability.
811
+ supports pattern matching to filter components and various output formats for better readability.
812
+ for ai-agent workflows, use --name-only to list what changed, --file to drill into a specific file,
813
+ --files-only / --configs-only to focus on one diff category, or --json for machine-readable output.
812
814
 
813
815
  `bit diff [component-pattern] [version] [to-version]`
814
816
 
@@ -818,11 +820,17 @@ supports pattern matching to filter components and various output formats for be
818
820
  | `version` | the base version to compare from. if omitted, compares the workspace's current files to the component's latest version. |
819
821
  | `to-version` | the target version to compare against "version". if both "version" and "to-version" are provided, compare those two versions directly (ignoring the workspace). |
820
822
 
821
- | **Option** | **Option alias** | **Description** |
822
- | ----------- | :--------------: | ----------------------------------------------------------------------------------------------- |
823
- | `--parent` | `-p` | compare the specified "version" to its immediate parent instead of comparing to the current one |
824
- | `--verbose` | `-v` | show a more verbose output where possible |
825
- | `--table` | `-t` | show tables instead of plain text for dependencies diff |
823
+ | **Option** | **Option alias** | **Description** |
824
+ | ---------------- | :--------------: | ---------------------------------------------------------------------------------------------------- |
825
+ | `--parent` | `-p` | compare the specified "version" to its immediate parent instead of comparing to the current one |
826
+ | `--verbose` | `-v` | show a more verbose output where possible |
827
+ | `--table` | `-t` | show tables instead of plain text for dependencies diff |
828
+ | `--file <paths>` | | show only file diffs for the given component-relative path(s). comma-separated. implies --files-only |
829
+ | `--files-only` | | show only file-content diffs; omit dependency, env, and aspect-config changes |
830
+ | `--configs-only` | | show only dependency, env, and aspect-config changes; omit file-content diffs |
831
+ | `--name-only` | | summary: list changed files with status (M/A/D) and changed field categories; no diff bodies |
832
+ | `--stat` | | summary: like --name-only but includes +N -M line counts per file |
833
+ | `--json` | `-j` | return the diff result as json |
826
834
 
827
835
  ---
828
836
 
@@ -1202,6 +1210,7 @@ supports various reset options to recover from corrupted state or restart from s
1202
1210
  | `--shared <groupname>` | `-s` | add group write permissions to a scope properly |
1203
1211
  | `--external-package-manager` | | enable external package manager mode (npm/yarn/pnpm) |
1204
1212
  | `--skip-interactive` | | skip interactive mode for Git repositories |
1213
+ | `--agent [type]` | | create an AI agent instructions file. options: claude, cursor, copilot (default: AGENTS.md) |
1205
1214
 
1206
1215
  ---
1207
1216
 
@@ -1934,6 +1943,7 @@ installs dependencies and configures the workspace for immediate development.
1934
1943
  | `--empty` | `-e` | skip template's default component creation (relevant for templates that add components by default) |
1935
1944
  | `--load-from <path-to-template>` | | local path to the workspace containing the template. Helpful during a development of a workspace-template |
1936
1945
  | `--current-dir` | `-c` | create the new workspace in current directory (default is to create a new directory, inside the current dir) |
1946
+ | `--agent [type]` | | create an AI agent instructions file. options: claude, cursor, copilot (default: AGENTS.md) |
1937
1947
 
1938
1948
  ---
1939
1949
 
@@ -1,4 +1,4 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.13.140'
2
+ description: 'Bit command synopses. Bit version: 1.13.142'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
@@ -1857,6 +1857,11 @@
1857
1857
  "c",
1858
1858
  "current-dir",
1859
1859
  "create the new workspace in current directory (default is to create a new directory, inside the current dir)"
1860
+ ],
1861
+ [
1862
+ "",
1863
+ "agent [type]",
1864
+ "create an AI agent instructions file. options: claude, cursor, copilot (default: AGENTS.md)"
1860
1865
  ]
1861
1866
  ],
1862
1867
  "description": "create a new Bit workspace from a template",
@@ -3730,10 +3735,40 @@
3730
3735
  "t",
3731
3736
  "table",
3732
3737
  "show tables instead of plain text for dependencies diff"
3738
+ ],
3739
+ [
3740
+ "",
3741
+ "file <paths>",
3742
+ "show only file diffs for the given component-relative path(s). comma-separated. implies --files-only"
3743
+ ],
3744
+ [
3745
+ "",
3746
+ "files-only",
3747
+ "show only file-content diffs; omit dependency, env, and aspect-config changes"
3748
+ ],
3749
+ [
3750
+ "",
3751
+ "configs-only",
3752
+ "show only dependency, env, and aspect-config changes; omit file-content diffs"
3753
+ ],
3754
+ [
3755
+ "",
3756
+ "name-only",
3757
+ "summary: list changed files with status (M/A/D) and changed field categories; no diff bodies"
3758
+ ],
3759
+ [
3760
+ "",
3761
+ "stat",
3762
+ "summary: like --name-only but includes +N -M line counts per file"
3763
+ ],
3764
+ [
3765
+ "j",
3766
+ "json",
3767
+ "return the diff result as json"
3733
3768
  ]
3734
3769
  ],
3735
3770
  "description": "compare component changes between versions or against the current workspace",
3736
- "extendedDescription": "shows a detailed diff of component files, dependencies, and configuration changes. \nby default, compares workspace changes against the latest version. specify versions to compare historical changes.\nsupports pattern matching to filter components and various output formats for better readability.",
3771
+ "extendedDescription": "shows a detailed diff of component files, dependencies, and configuration changes.\nby default, compares workspace changes against the latest version. specify versions to compare historical changes.\nsupports pattern matching to filter components and various output formats for better readability.\nfor ai-agent workflows, use --name-only to list what changed, --file to drill into a specific file,\n--files-only / --configs-only to focus on one diff category, or --json for machine-readable output.",
3737
3772
  "group": "info-analysis",
3738
3773
  "private": false,
3739
3774
  "arguments": [
@@ -3774,6 +3809,22 @@
3774
3809
  {
3775
3810
  "cmd": "diff foo 0.0.2 --parent",
3776
3811
  "description": "compare \"foo@0.0.2\" to its parent version. showing what changed in 0.0.2"
3812
+ },
3813
+ {
3814
+ "cmd": "diff foo --name-only",
3815
+ "description": "list changed files and field categories without diff bodies"
3816
+ },
3817
+ {
3818
+ "cmd": "diff foo --file src/index.ts",
3819
+ "description": "show the diff of a single file in a component"
3820
+ },
3821
+ {
3822
+ "cmd": "diff foo --files-only",
3823
+ "description": "show only source-code diffs, skip dependency/config changes"
3824
+ },
3825
+ {
3826
+ "cmd": "diff foo --json",
3827
+ "description": "return the diff result as json for programmatic consumption"
3777
3828
  }
3778
3829
  ]
3779
3830
  },
@@ -5142,6 +5193,11 @@
5142
5193
  "",
5143
5194
  "skip-interactive",
5144
5195
  "skip interactive mode for Git repositories"
5196
+ ],
5197
+ [
5198
+ "",
5199
+ "agent [type]",
5200
+ "create an AI agent instructions file. options: claude, cursor, copilot (default: AGENTS.md)"
5145
5201
  ]
5146
5202
  ],
5147
5203
  "description": "initialize a Bit workspace in an existing project",
@@ -1711,7 +1711,7 @@ function _createMdxContent(props) {
1711
1711
  }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
1712
1712
  children: [(0, _jsxRuntime.jsx)(_components.strong, {
1713
1713
  children: "Description"
1714
- }), ": compare component changes between versions or against the current workspace", (0, _jsxRuntime.jsx)(_components.br, {}), "\n", "shows a detailed diff of component files, dependencies, and configuration changes.", (0, _jsxRuntime.jsx)(_components.br, {}), "\n", "by default, compares workspace changes against the latest version. specify versions to compare historical changes.", (0, _jsxRuntime.jsx)(_components.br, {}), "\n", "supports pattern matching to filter components and various output formats for better readability."]
1714
+ }), ": compare component changes between versions or against the current workspace", (0, _jsxRuntime.jsx)(_components.br, {}), "\n", "shows a detailed diff of component files, dependencies, and configuration changes.", (0, _jsxRuntime.jsx)(_components.br, {}), "\n", "by default, compares workspace changes against the latest version. specify versions to compare historical changes.", (0, _jsxRuntime.jsx)(_components.br, {}), "\n", "supports pattern matching to filter components and various output formats for better readability.", (0, _jsxRuntime.jsx)(_components.br, {}), "\n", "for ai-agent workflows, use --name-only to list what changed, --file to drill into a specific file,", (0, _jsxRuntime.jsx)(_components.br, {}), "\n", "--files-only / --configs-only to focus on one diff category, or --json for machine-readable output."]
1715
1715
  }), "\n", (0, _jsxRuntime.jsx)(_components.p, {
1716
1716
  children: (0, _jsxRuntime.jsx)(_components.code, {
1717
1717
  children: "bit diff [component-pattern] [version] [to-version]"
@@ -1735,23 +1735,37 @@ function _createMdxContent(props) {
1735
1735
  }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
1736
1736
  children: ["| ", (0, _jsxRuntime.jsx)(_components.strong, {
1737
1737
  children: "Option"
1738
- }), " | ", (0, _jsxRuntime.jsx)(_components.strong, {
1738
+ }), " | ", (0, _jsxRuntime.jsx)(_components.strong, {
1739
1739
  children: "Option alias"
1740
1740
  }), " | ", (0, _jsxRuntime.jsx)(_components.strong, {
1741
1741
  children: "Description"
1742
- }), " |\n| ----------- | :--------------: | ----------------------------------------------------------------------------------------------- |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
1742
+ }), " |\n| ---------------- | :--------------: | ---------------------------------------------------------------------------------------------------- |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
1743
1743
  children: "--parent"
1744
- }), " | ", (0, _jsxRuntime.jsx)(_components.code, {
1744
+ }), " | ", (0, _jsxRuntime.jsx)(_components.code, {
1745
1745
  children: "-p"
1746
- }), " | compare the specified \"version\" to its immediate parent instead of comparing to the current one |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
1746
+ }), " | compare the specified \"version\" to its immediate parent instead of comparing to the current one |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
1747
1747
  children: "--verbose"
1748
- }), " | ", (0, _jsxRuntime.jsx)(_components.code, {
1748
+ }), " | ", (0, _jsxRuntime.jsx)(_components.code, {
1749
1749
  children: "-v"
1750
- }), " | show a more verbose output where possible |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
1750
+ }), " | show a more verbose output where possible |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
1751
1751
  children: "--table"
1752
- }), " | ", (0, _jsxRuntime.jsx)(_components.code, {
1752
+ }), " | ", (0, _jsxRuntime.jsx)(_components.code, {
1753
1753
  children: "-t"
1754
- }), " | show tables instead of plain text for dependencies diff |"]
1754
+ }), " | show tables instead of plain text for dependencies diff |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
1755
+ children: "--file <paths>"
1756
+ }), " | | show only file diffs for the given component-relative path(s). comma-separated. implies --files-only |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
1757
+ children: "--files-only"
1758
+ }), " | | show only file-content diffs; omit dependency, env, and aspect-config changes |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
1759
+ children: "--configs-only"
1760
+ }), " | | show only dependency, env, and aspect-config changes; omit file-content diffs |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
1761
+ children: "--name-only"
1762
+ }), " | | summary: list changed files with status (M/A/D) and changed field categories; no diff bodies |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
1763
+ children: "--stat"
1764
+ }), " | | summary: like --name-only but includes +N -M line counts per file |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
1765
+ children: "--json"
1766
+ }), " | ", (0, _jsxRuntime.jsx)(_components.code, {
1767
+ children: "-j"
1768
+ }), " | return the diff result as json |"]
1755
1769
  }), "\n", (0, _jsxRuntime.jsx)(_components.hr, {}), "\n", (0, _jsxRuntime.jsx)(_components.h2, {
1756
1770
  children: "doctor"
1757
1771
  }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
@@ -2495,7 +2509,9 @@ function _createMdxContent(props) {
2495
2509
  children: "--external-package-manager"
2496
2510
  }), " | | enable external package manager mode (npm/yarn/pnpm) |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2497
2511
  children: "--skip-interactive"
2498
- }), " | | skip interactive mode for Git repositories |"]
2512
+ }), " | | skip interactive mode for Git repositories |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
2513
+ children: "--agent [type]"
2514
+ }), " | | create an AI agent instructions file. options: claude, cursor, copilot (default: AGENTS.md) |"]
2499
2515
  }), "\n", (0, _jsxRuntime.jsx)(_components.hr, {}), "\n", (0, _jsxRuntime.jsx)(_components.h2, {
2500
2516
  children: "install"
2501
2517
  }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
@@ -3965,7 +3981,9 @@ function _createMdxContent(props) {
3965
3981
  children: "--current-dir"
3966
3982
  }), " | ", (0, _jsxRuntime.jsx)(_components.code, {
3967
3983
  children: "-c"
3968
- }), " | create the new workspace in current directory (default is to create a new directory, inside the current dir) |"]
3984
+ }), " | create the new workspace in current directory (default is to create a new directory, inside the current dir) |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
3985
+ children: "--agent [type]"
3986
+ }), " | | create an AI agent instructions file. options: claude, cursor, copilot (default: AGENTS.md) |"]
3969
3987
  }), "\n", (0, _jsxRuntime.jsx)(_components.hr, {}), "\n", (0, _jsxRuntime.jsx)(_components.h2, {
3970
3988
  children: "npmrc"
3971
3989
  }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {