@teambit/harmony.content.cli-reference 2.0.1002 → 2.0.1004

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.139'
2
+ description: 'Bit command synopses. Bit version: 1.13.141'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
@@ -1445,6 +1445,43 @@
1445
1445
  "remoteOp": true,
1446
1446
  "skipWorkspace": true
1447
1447
  },
1448
+ {
1449
+ "name": "search <query...>",
1450
+ "alias": "",
1451
+ "options": [
1452
+ [
1453
+ "o",
1454
+ "owners <list>",
1455
+ "comma-separated list of owners/orgs to filter remote results by"
1456
+ ],
1457
+ [
1458
+ "",
1459
+ "skip-auto-owner",
1460
+ "do not auto-extract owner from workspace defaultScope"
1461
+ ],
1462
+ [
1463
+ "r",
1464
+ "remote-only",
1465
+ "only search remote bit cloud, skip local workspace"
1466
+ ],
1467
+ [
1468
+ "l",
1469
+ "local-only",
1470
+ "only search the local workspace, skip remote bit cloud"
1471
+ ],
1472
+ [
1473
+ "j",
1474
+ "json",
1475
+ "show the output in JSON format"
1476
+ ]
1477
+ ],
1478
+ "description": "search for components by keyword in the local workspace and remote bit cloud",
1479
+ "extendedDescription": "runs the provided query terms in parallel against bit cloud and against the local workspace.\nmultiple queries are unioned (deduplicated) in the output. by default, remote results are filtered by the\nowner extracted from the workspace's defaultScope; use --owners or --skip-auto-owner to change this.",
1480
+ "group": "info-analysis",
1481
+ "private": false,
1482
+ "remoteOp": true,
1483
+ "skipWorkspace": true
1484
+ },
1448
1485
  {
1449
1486
  "name": "ws-config <sub-command>",
1450
1487
  "alias": "workspace-config",
@@ -3693,10 +3730,40 @@
3693
3730
  "t",
3694
3731
  "table",
3695
3732
  "show tables instead of plain text for dependencies diff"
3733
+ ],
3734
+ [
3735
+ "",
3736
+ "file <paths>",
3737
+ "show only file diffs for the given component-relative path(s). comma-separated. implies --files-only"
3738
+ ],
3739
+ [
3740
+ "",
3741
+ "files-only",
3742
+ "show only file-content diffs; omit dependency, env, and aspect-config changes"
3743
+ ],
3744
+ [
3745
+ "",
3746
+ "configs-only",
3747
+ "show only dependency, env, and aspect-config changes; omit file-content diffs"
3748
+ ],
3749
+ [
3750
+ "",
3751
+ "name-only",
3752
+ "summary: list changed files with status (M/A/D) and changed field categories; no diff bodies"
3753
+ ],
3754
+ [
3755
+ "",
3756
+ "stat",
3757
+ "summary: like --name-only but includes +N -M line counts per file"
3758
+ ],
3759
+ [
3760
+ "j",
3761
+ "json",
3762
+ "return the diff result as json"
3696
3763
  ]
3697
3764
  ],
3698
3765
  "description": "compare component changes between versions or against the current workspace",
3699
- "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.",
3766
+ "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.",
3700
3767
  "group": "info-analysis",
3701
3768
  "private": false,
3702
3769
  "arguments": [
@@ -3737,6 +3804,22 @@
3737
3804
  {
3738
3805
  "cmd": "diff foo 0.0.2 --parent",
3739
3806
  "description": "compare \"foo@0.0.2\" to its parent version. showing what changed in 0.0.2"
3807
+ },
3808
+ {
3809
+ "cmd": "diff foo --name-only",
3810
+ "description": "list changed files and field categories without diff bodies"
3811
+ },
3812
+ {
3813
+ "cmd": "diff foo --file src/index.ts",
3814
+ "description": "show the diff of a single file in a component"
3815
+ },
3816
+ {
3817
+ "cmd": "diff foo --files-only",
3818
+ "description": "show only source-code diffs, skip dependency/config changes"
3819
+ },
3820
+ {
3821
+ "cmd": "diff foo --json",
3822
+ "description": "return the diff result as json for programmatic consumption"
3740
3823
  }
3741
3824
  ]
3742
3825
  },
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
 
@@ -2417,6 +2425,25 @@ use --list to see all available scripts.
2417
2425
 
2418
2426
  ---
2419
2427
 
2428
+ ## search
2429
+
2430
+ **Description**: search for components by keyword in the local workspace and remote bit cloud
2431
+ runs the provided query terms in parallel against bit cloud and against the local workspace.
2432
+ multiple queries are unioned (deduplicated) in the output. by default, remote results are filtered by the
2433
+ owner extracted from the workspace's defaultScope; use --owners or --skip-auto-owner to change this.
2434
+
2435
+ `bit search <query...>`
2436
+
2437
+ | **Option** | **Option alias** | **Description** |
2438
+ | ------------------- | :--------------: | --------------------------------------------------------------- |
2439
+ | `--owners <list>` | `-o` | comma-separated list of owners/orgs to filter remote results by |
2440
+ | `--skip-auto-owner` | | do not auto-extract owner from workspace defaultScope |
2441
+ | `--remote-only` | `-r` | only search remote bit cloud, skip local workspace |
2442
+ | `--local-only` | `-l` | only search the local workspace, skip remote bit cloud |
2443
+ | `--json` | `-j` | show the output in JSON format |
2444
+
2445
+ ---
2446
+
2420
2447
  ## set-peer
2421
2448
 
2422
2449
  **Description**: configure component to always be installed as peer dependency
@@ -1,4 +1,4 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.13.139'
2
+ description: 'Bit command synopses. Bit version: 1.13.141'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
@@ -1445,6 +1445,43 @@
1445
1445
  "remoteOp": true,
1446
1446
  "skipWorkspace": true
1447
1447
  },
1448
+ {
1449
+ "name": "search <query...>",
1450
+ "alias": "",
1451
+ "options": [
1452
+ [
1453
+ "o",
1454
+ "owners <list>",
1455
+ "comma-separated list of owners/orgs to filter remote results by"
1456
+ ],
1457
+ [
1458
+ "",
1459
+ "skip-auto-owner",
1460
+ "do not auto-extract owner from workspace defaultScope"
1461
+ ],
1462
+ [
1463
+ "r",
1464
+ "remote-only",
1465
+ "only search remote bit cloud, skip local workspace"
1466
+ ],
1467
+ [
1468
+ "l",
1469
+ "local-only",
1470
+ "only search the local workspace, skip remote bit cloud"
1471
+ ],
1472
+ [
1473
+ "j",
1474
+ "json",
1475
+ "show the output in JSON format"
1476
+ ]
1477
+ ],
1478
+ "description": "search for components by keyword in the local workspace and remote bit cloud",
1479
+ "extendedDescription": "runs the provided query terms in parallel against bit cloud and against the local workspace.\nmultiple queries are unioned (deduplicated) in the output. by default, remote results are filtered by the\nowner extracted from the workspace's defaultScope; use --owners or --skip-auto-owner to change this.",
1480
+ "group": "info-analysis",
1481
+ "private": false,
1482
+ "remoteOp": true,
1483
+ "skipWorkspace": true
1484
+ },
1448
1485
  {
1449
1486
  "name": "ws-config <sub-command>",
1450
1487
  "alias": "workspace-config",
@@ -3693,10 +3730,40 @@
3693
3730
  "t",
3694
3731
  "table",
3695
3732
  "show tables instead of plain text for dependencies diff"
3733
+ ],
3734
+ [
3735
+ "",
3736
+ "file <paths>",
3737
+ "show only file diffs for the given component-relative path(s). comma-separated. implies --files-only"
3738
+ ],
3739
+ [
3740
+ "",
3741
+ "files-only",
3742
+ "show only file-content diffs; omit dependency, env, and aspect-config changes"
3743
+ ],
3744
+ [
3745
+ "",
3746
+ "configs-only",
3747
+ "show only dependency, env, and aspect-config changes; omit file-content diffs"
3748
+ ],
3749
+ [
3750
+ "",
3751
+ "name-only",
3752
+ "summary: list changed files with status (M/A/D) and changed field categories; no diff bodies"
3753
+ ],
3754
+ [
3755
+ "",
3756
+ "stat",
3757
+ "summary: like --name-only but includes +N -M line counts per file"
3758
+ ],
3759
+ [
3760
+ "j",
3761
+ "json",
3762
+ "return the diff result as json"
3696
3763
  ]
3697
3764
  ],
3698
3765
  "description": "compare component changes between versions or against the current workspace",
3699
- "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.",
3766
+ "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.",
3700
3767
  "group": "info-analysis",
3701
3768
  "private": false,
3702
3769
  "arguments": [
@@ -3737,6 +3804,22 @@
3737
3804
  {
3738
3805
  "cmd": "diff foo 0.0.2 --parent",
3739
3806
  "description": "compare \"foo@0.0.2\" to its parent version. showing what changed in 0.0.2"
3807
+ },
3808
+ {
3809
+ "cmd": "diff foo --name-only",
3810
+ "description": "list changed files and field categories without diff bodies"
3811
+ },
3812
+ {
3813
+ "cmd": "diff foo --file src/index.ts",
3814
+ "description": "show the diff of a single file in a component"
3815
+ },
3816
+ {
3817
+ "cmd": "diff foo --files-only",
3818
+ "description": "show only source-code diffs, skip dependency/config changes"
3819
+ },
3820
+ {
3821
+ "cmd": "diff foo --json",
3822
+ "description": "return the diff result as json for programmatic consumption"
3740
3823
  }
3741
3824
  ]
3742
3825
  },
@@ -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, {
@@ -4890,6 +4904,42 @@ function _createMdxContent(props) {
4890
4904
  }), " | ", (0, _jsxRuntime.jsx)(_components.code, {
4891
4905
  children: "-l"
4892
4906
  }), " | list all available scripts from all environments |"]
4907
+ }), "\n", (0, _jsxRuntime.jsx)(_components.hr, {}), "\n", (0, _jsxRuntime.jsx)(_components.h2, {
4908
+ children: "search"
4909
+ }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
4910
+ children: [(0, _jsxRuntime.jsx)(_components.strong, {
4911
+ children: "Description"
4912
+ }), ": search for components by keyword in the local workspace and remote bit cloud", (0, _jsxRuntime.jsx)(_components.br, {}), "\n", "runs the provided query terms in parallel against bit cloud and against the local workspace.", (0, _jsxRuntime.jsx)(_components.br, {}), "\n", "multiple queries are unioned (deduplicated) in the output. by default, remote results are filtered by the", (0, _jsxRuntime.jsx)(_components.br, {}), "\n", "owner extracted from the workspace's defaultScope; use --owners or --skip-auto-owner to change this."]
4913
+ }), "\n", (0, _jsxRuntime.jsx)(_components.p, {
4914
+ children: (0, _jsxRuntime.jsx)(_components.code, {
4915
+ children: "bit search <query...>"
4916
+ })
4917
+ }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
4918
+ children: ["| ", (0, _jsxRuntime.jsx)(_components.strong, {
4919
+ children: "Option"
4920
+ }), " | ", (0, _jsxRuntime.jsx)(_components.strong, {
4921
+ children: "Option alias"
4922
+ }), " | ", (0, _jsxRuntime.jsx)(_components.strong, {
4923
+ children: "Description"
4924
+ }), " |\n| ------------------- | :--------------: | --------------------------------------------------------------- |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
4925
+ children: "--owners <list>"
4926
+ }), " | ", (0, _jsxRuntime.jsx)(_components.code, {
4927
+ children: "-o"
4928
+ }), " | comma-separated list of owners/orgs to filter remote results by |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
4929
+ children: "--skip-auto-owner"
4930
+ }), " | | do not auto-extract owner from workspace defaultScope |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
4931
+ children: "--remote-only"
4932
+ }), " | ", (0, _jsxRuntime.jsx)(_components.code, {
4933
+ children: "-r"
4934
+ }), " | only search remote bit cloud, skip local workspace |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
4935
+ children: "--local-only"
4936
+ }), " | ", (0, _jsxRuntime.jsx)(_components.code, {
4937
+ children: "-l"
4938
+ }), " | only search the local workspace, skip remote bit cloud |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
4939
+ children: "--json"
4940
+ }), " | ", (0, _jsxRuntime.jsx)(_components.code, {
4941
+ children: "-j"
4942
+ }), " | show the output in JSON format |"]
4893
4943
  }), "\n", (0, _jsxRuntime.jsx)(_components.hr, {}), "\n", (0, _jsxRuntime.jsx)(_components.h2, {
4894
4944
  children: "set-peer"
4895
4945
  }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {