Merge branch 'main' of https://github.com/iTwin/itwin-cli into wolfo951/initial-docs-generator-command

Author: wolfo951

.vscode/launch.json

@@ -29,6 +29,40 @@
             "args": [
                 "readme"
             ]
+        },
+        {
+            "name": "Debug All Tests",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "type": "node",
+            "request": "launch",
+            "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/mocha",
+            "args": [
+                "--forbid-only",
+                "--timeout",
+                "999999",
+                "integration-tests/**/api.test.ts"
+            ],
+            "console": "integratedTerminal",
+            "internalConsoleOptions": "neverOpen"
+        },
+        {
+            "name": "Debug Active Test",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "type": "node",
+            "request": "launch",
+            "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/mocha",
+            "args": [
+                "--forbid-only",
+                "--timeout",
+                "999999",
+                "${file}"
+            ],
+            "console": "integratedTerminal",
+            "internalConsoleOptions": "neverOpen"
         }
     ]
 }

docs/_sidebar.md

@@ -1,54 +1,62 @@
-* [iTwin CLI Manual](/)
-* [Quickstart](/quickstart.md)
-* [Workflows](workflows/overview.md)
-* [itp](itp.md)
-* [options](options.md)
-* [auth](auth/overview.md)
-  * [login](auth/login.md)
-  * [logout](auth/logout.md)
-* [api](api.md)
-* [itwin](itwin/overview.md)
-  * [create](itwin/create.md)
-  * [update](itwin/update.md)
-  * [delete](itwin/delete.md)
-  * [info](itwin/info.md)
-  * [list](itwin/list.md)
-  * [repository](itwin/repository/overview.md)
-* [imodel](imodel/overview.md)
-  * [create](imodel/create.md)
-  * [populate](imodel/populate.md)
-  * [update](imodel/update.md)
-  * [delete](imodel/delete.md)
-  * [info](imodel/info.md)
-  * [list](imodel/list.md)
-  * [view](imodel/view/overview.md)
-    * [cesium-sandcastle](imodel/view/cesium-sandcastle.md)
-  * [changeset](imodel/changeset/overview.md)
-  * [named-version](imodel/named-version/overview.md)
-  * [connection](imodel/connection/overview.md)
-    * [run](imodel/connection/run/overview.md)
-    * [sourcefile](imodel/connection/sourcefile/overview.md)
-* [changed-elements](changed-elements/overview.md)
-  * [enable](changed-elements/enable.md)
-  * [disable](changed-elements/disable.md)
-  * [info](changed-elements/info.md)
-  * [changesets](changed-elements/changesets.md)
-  * [comparison](changed-elements/comparison.md)
-* [storage](storage/overview.md)
-  * [root-folder](storage/root-folder.md)
-  * [file](storage/file/overview.md)
-  * [folder](storage/folder/overview.md)
-* [user](user/overview.md)
-  * [me](user/me.md)
-  * [info](user/info.md)
-  * [search](user/search.md)
-* [access-control](access-control/overview.md)
-  * [permissions](access-control/permissions/overview.md)
-  * [role](access-control/role/overview.md)
-  * [group](access-control/group/overview.md)
-  * [member](access-control/member/overview.md)
-    * [group](access-control/member/group/overview.md)
-    * [owner](access-control/member/owner/overview.md)
-    * [user](access-control/member/user/overview.md)
-* [combined commands](combined-commands/overview.md)
-  * [synchronization](combined-commands/synchronization.md)
+* [iTwin CLI Manual](/docs/)
+* [Quickstart](/docs/quickstart.md)
+* [Workflows](/docs/workflows/overview.md)
+
+<hr style="margin: 1em 5em 1em 1em; opacity: 0.1;">
+
+* [itp](/docs/itp.md)
+* [options](/docs/options.md)
+* [auth](/docs/auth/overview.md)
+  * [info](/docs/auth/info.md) 
+  * [login](/docs/auth/login.md)
+  * [logout](/docs/auth/logout.md)
+* [api](/docs/api.md)
+* [itwin](/docs/itwin/overview.md)
+  * [create](/docs/itwin/create.md)
+  * [update](/docs/itwin/update.md)
+  * [delete](/docs/itwin/delete.md)
+  * [info](/docs/itwin/info.md)
+  * [list](/docs/itwin/list.md)
+  * [repository](/docs/itwin/repository/overview.md)
+* [imodel](/docs/imodel/overview.md)
+  * [create](/docs/imodel/create.md)
+  * [populate](/docs/imodel/populate.md)
+  * [update](/docs/imodel/update.md)
+  * [delete](/docs/imodel/delete.md)
+  * [info](/docs/imodel/info.md)
+  * [list](/docs/imodel/list.md)
+  * [view](/docs/imodel/view/overview.md)
+    * [cesium-sandcastle](/docs/imodel/view/cesium-sandcastle.md)
+  * [changeset](/docs/imodel/changeset/overview.md)
+  * [named-version](/docs/imodel/named-version/overview.md)
+  * [connection](/docs/imodel/connection/overview.md)
+    * [run](/docs/imodel/connection/run/overview.md)
+    * [sourcefile](/docs/imodel/connection/sourcefile/overview.md)
+* [changed-elements](/docs/changed-elements/overview.md)
+  * [enable](/docs/changed-elements/enable.md)
+  * [disable](/docs/changed-elements/disable.md)
+  * [info](/docs/changed-elements/info.md)
+  * [changesets](/docs/changed-elements/changesets.md)
+  * [comparison](/docs/changed-elements/comparison.md)
+* [storage](/docs/storage/overview.md)
+  * [root-folder](/docs/storage/root-folder.md)
+  * [file](/docs/storage/file/overview.md)
+  * [folder](/docs/storage/folder/overview.md)
+* [user](/docs/user/overview.md)
+  * [me](/docs/user/me.md)
+  * [info](/docs/user/info.md)
+  * [search](/docs/user/search.md)
+* [access-control](/docs/access-control/overview.md)
+  * [permissions](/docs/access-control/permissions/overview.md)
+  * [role](/docs/access-control/role/overview.md)
+  * [group](/docs/access-control/group/overview.md)
+  * [member](/docs/access-control/member/overview.md)
+    * [group](/docs/access-control/member/group/overview.md)
+    * [owner](/docs/access-control/member/owner/overview.md)
+    * [user](/docs/access-control/member/user/overview.md)
+
+<hr style="margin: 1em 5em 1em 1em; opacity: 0.1;">
+
+* [Command Workflows](/docs/command-workflows/overview.md)
+  * [iModel Populate](/docs/command-workflows/imodel-populate.md)
+  * [Cesium Sandcastle Export](/docs/command-workflows/cesium-sandcastle.md)

docs/access-control/group/overview.md

@@ -4,8 +4,8 @@ Manage iTwin access control groups.
 
 ## Available Commands
 
-- [itp access-control group create](access-control/group/create.md)
-- [itp access-control group update](access-control/group/update.md)
-- [itp access-control group delete](access-control/group/delete.md)
-- [itp access-control group info](access-control/group/info.md)
-- [itp access-control group list](access-control/group/list.md)
+- [itp access-control group create](create.md)
+- [itp access-control group update](update.md)
+- [itp access-control group delete](delete.md)
+- [itp access-control group info](info.md)
+- [itp access-control group list](list.md)

docs/access-control/group/update.md

@@ -20,11 +20,11 @@ Update the details of an existing group in an iTwin.
   The updated description of the group.  
   **Type:** `string` **Required:** No
 
-- **`--members`**  
+- **`--member`**  
   A list of members (emails) to be assigned to the group.  
   **Type:** `array of strings` **Required:** No **Multiple:** Yes
 
-- **`--ims-groups`**  
+- **`--ims-group`**  
   A list of IMS Groups to be linked to the group.  
   **Type:** `array of strings` **Required:** No **Multiple:** Yes
 
@@ -35,7 +35,7 @@ Update the details of an existing group in an iTwin.
 itp access-control group update --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --group-id bf4d8b36-25d7-4b72-b38b-12c1f0325f42 --name "Updated Engineering Team" --description "Updated description"
 
 # Example 2: Update group members and IMS groups
-itp access-control group update --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --group-id bf4d8b36-25d7-4b72-b38b-12c1f0325f42 --members [email protected] --members [email protected] --imsGroups "Sample IMS Group" --imsGroups "Sample IMS Group"
+itp access-control group update --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --group-id bf4d8b36-25d7-4b72-b38b-12c1f0325f42 --member [email protected] --member [email protected] --ims-groups "Sample IMS Group" --ims-group "Sample IMS Group"
 ```
 
 ## API Reference

docs/access-control/member/group/overview.md

@@ -4,8 +4,8 @@ Manage groups that can access an iTwin.
 
 ## Available Commands
 
-- [itp access-control member group add](access-control/member/group/add.md)
-- [itp access-control member group update](access-control/member/group/update.md)
-- [itp access-control member group delete](access-control/member/group/delete.md)
-- [itp access-control member group info](access-control/member/group/info.md)
-- [itp access-control member group list](access-control/member/group/list.md)
+- [itp access-control member group add](add.md)
+- [itp access-control member group update](update.md)
+- [itp access-control member group delete](delete.md)
+- [itp access-control member group info](info.md)
+- [itp access-control member group list](list.md)

docs/access-control/member/group/update.md

@@ -12,14 +12,14 @@ Update the role assignments for a group in an iTwin.
   The ID of the group whose roles will be updated.  
   **Type:** `string` **Required:** Yes
 
-- **`--role-ids`**  
+- **`--role-id`**  
   A list of role IDs to assign to the group.  
   **Type:** `array` **Required:** Yes **Multiple:** Yes
 
 ## Examples
 
 ```bash
-itp access-control member group update --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --group-id group1-id --role-ids role1-id --role-ids role2-id
+itp access-control member group update --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --group-id group1-id --role-id role1-id --role-id role2-id
 ```
 
 ## API Reference

docs/access-control/member/overview.md

@@ -4,7 +4,7 @@ Manage members that can access an iTwin.
 
 ## Available Commands
 
-- [itp access-control member invitations](access-control/member/invitations.md)
-- [itp access-control member owner](access-control/member/owner/overview.md)
-- [itp access-control member group](access-control/member/group/overview.md)
-- [itp access-control member user](access-control/member/user/overview.md)
+- [itp access-control member invitations](invitations.md)
+- [itp access-control member owner](owner/overview.md)
+- [itp access-control member group](group/overview.md)
+- [itp access-control member user](user/overview.md)

docs/access-control/member/owner/overview.md

@@ -4,6 +4,6 @@ Manage access control for iTwin owners.
 
 ## Available Commands
 
-- [itp access-control member owner add](access-control/member/owner/add.md)
-- [itp access-control member owner delete](access-control/member/owner/delete.md)
-- [itp access-control member owner list](access-control/member/owner/list.md)
+- [itp access-control member owner add](add.md)
+- [itp access-control member owner delete](delete.md)
+- [itp access-control member owner list](list.md)

docs/access-control/member/user/overview.md

@@ -4,8 +4,8 @@ Manage users that can access an iTwin.
 
 ## Available Commands
 
-- [itp access-control member user add](access-control/member/user/add.md)
-- [itp access-control member user update](access-control/member/user/update.md)
-- [itp access-control member user delete](access-control/member/user/delete.md)
-- [itp access-control member user info](access-control/member/user/info.md)
-- [itp access-control member user list](access-control/member/user/list.md)
+- [itp access-control member user add](add.md)
+- [itp access-control member user update](update.md)
+- [itp access-control member user delete](delete.md)
+- [itp access-control member user info](info.md)
+- [itp access-control member user list](list.md)

docs/access-control/member/user/update.md

@@ -12,14 +12,14 @@ Update the role assignments for a user in an iTwin.
   The ID of the user whose roles will be updated.  
   **Type:** `string` **Required:** Yes
 
-- **`--role-ids`**  
+- **`--role-id`**  
   A list of role IDs to assign to the user.  
   **Type:** `array` **Required:** Yes **Multiple:** Yes
 
 ## Examples
 
 ```bash
-itp access-control member user update --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --member-id user1-id --role-ids role1-id --role-ids role2-id
+itp access-control member user update --itwin-id ad0ba809-9241-48ad-9eb0-c8038c1a1d51 --member-id user1-id --role-id role1-id --role-id role2-id
 ```
 
 ## API Reference