You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-9Lines changed: 4 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,19 @@
1
-
> **⚠️ Note:**
2
-
> The iTwin CLI is in active development and is **not intended for production workflows**. It is pre-release and may contain breaking changes in the future.
3
-
4
-
5
1
# iTwin Platform CLI
6
2
7
3
The **iTwin Platform CLI** is a command-line tool for interacting with the [iTwin Platform](https://developer.bentley.com). It enables automation of common workflows such as managing iTwins and iModels, synchronizing design data, handling storage, and controlling user access.
8
4
9
5
🚀 **Why use the iTwin CLI?**
10
-
- Automate iTwin and iModel creation, updates, and management.
6
+
- Automate creation of iTwins and iModels, updates and management.
11
7
- Streamline design data synchronization and versioning.
12
8
- Manage users, roles, and permissions efficiently.
13
9
- Automate workflows with scripts, scheduled tasks, and data pipelines.
14
10
11
+
For a step-by-step guide on getting started with an iTwin, see the **[Quickstart](https://itwin.github.io/itwin-cli/#/quickstart)**. For a complete list of commands and usage examples, visit the **[iTwin CLI Manual](https://itwin.github.io/itwin-cli)**.
12
+
15
13
## **Getting Started**
16
14
17
15
### **1. Install the CLI**
18
-
Download the latest version for your operating system from the **[Releases](https://github.com/itwin/itwin-cli/releases)** page.
16
+
Download the latest version for your operating system from the **[Releases](https://github.com/itwin/itwin-cli/releases)** page and install it.
19
17
20
18
### **2. Authenticate with the iTwin Platform**
21
19
Before using the CLI, sign in:
@@ -36,9 +34,6 @@ NOTE: As of June 16th, 2025 only `bash`, `zsh` and `powershell` are supported.
36
34
itp plugins install @oclif/plugin-autocomplete
37
35
itp autocomplete
38
36
```
39
-
40
-
For a step-by-step guide on getting started with an iTwin, see the **[Quickstart](https://cuddly-engine-j746ov3.pages.github.io/#/quickstart)**. For a complete list of commands and usage examples, visit the **[iTwin CLI Manual](https://cuddly-engine-j746ov3.pages.github.io/#/)**.
0 commit comments