|
1 | | -# iTwin CLI Manual |
| 1 | +# Welcome to iTwin CLI |
2 | 2 |
|
3 | | -Welcome to the **iTwin CLI Manual**. This guide will help you get started with the iTwin CLI, a command-line tool designed to automate workflows, manage iTwins and iModels, and streamline interactions with the iTwin Platform. |
| 3 | +This guide will help you get started with the [iTwin CLI](https://github.com/iTwin/itwin-cli) — a command-line tool designed to streamline interactions with the iTwin Platform, manage iTwins and iModels, and automate your digital twin workflows. |
| 4 | + |
| 5 | +> 💡 New to iTwins? Check out our [iTwin 101 guide](itwin101.md) for an introduction to the platform. |
4 | 6 |
|
5 | 7 | ## What is the iTwin CLI? |
6 | 8 |
|
7 | 9 | The iTwin CLI enables users to: |
8 | 10 |
|
9 | | -- Create and manage iTwins and iModels for digital twin projects. |
10 | | -- Automate data workflows, such as synchronizing design files and tracking changes. |
11 | | -- Manage access control by organizing users, assigning roles, and setting permissions. |
12 | | -- Organize and store data within iTwin storage and repositories. |
| 11 | +- Interact with the iTwin Platform through simple commands |
| 12 | +- Create and manage iTwins and iModels for your digital twin projects |
| 13 | +- Organize and store data using iTwin storage and repositories |
| 14 | +- Manage access control by organizing users, assigning roles, and setting permissions |
| 15 | +- Automate data workflows, such as synchronizing design files and tracking changes |
13 | 16 |
|
14 | 17 | Whether you're a first-time user or an experienced developer, this CLI provides essential commands to optimize your iTwin workflows. |
15 | 18 |
|
16 | 19 | --- |
17 | 20 |
|
18 | 21 | ## Installation |
19 | 22 |
|
20 | | -To install the iTwin CLI, follow these steps: |
| 23 | +Getting started with the iTwin CLI is quick and easy. Here's how to install it on your system: |
21 | 24 |
|
22 | 25 | 1. **Download the Installer** |
23 | | - Visit the [iTwin CLI Releases](https://github.com/itwin/itwin-cli/releases) page and download the latest version for your operating system. |
| 26 | + Head over to the [iTwin CLI Releases](https://github.com/iTwin/itwin-cli/releases/latest) page and grab the latest version for your operating system. |
24 | 27 |
|
25 | 28 | 2. **Run the Installer** |
26 | | - - **Windows**: Run the `.exe` file and follow the prompts. |
27 | | - - **macOS**: Open the `.pkg` file to install. |
| 29 | + The installation process varies depending on your system: |
| 30 | + - **Windows**: Double-click the `.exe` file and follow the installation wizard. |
| 31 | + - **macOS**: Open the `.pkg` file and complete the installation steps. |
28 | 32 | - **Linux**: Extract the `.tar.gz` file and run: |
29 | 33 | ```bash |
30 | 34 | sudo ./install.sh |
31 | 35 | ``` |
32 | 36 |
|
33 | | -3. **Verify Installation** |
34 | | - After installation, check if the CLI is set up correctly: |
| 37 | +3. **Verify Your Installation** |
| 38 | + To make sure everything is set up correctly, open your terminal and run: |
35 | 39 | ```bash |
36 | 40 | itp --version |
37 | 41 | ``` |
38 | | - This should display the installed version. |
| 42 | + You should see the version number of your installed CLI. If you get a `command not found` error, you might need to restart your terminal or check your system's PATH. |
| 43 | +
|
| 44 | +> 💡 Need help? Visit our [GitHub issues](https://github.com/iTwin/itwin-cli/issues) to get support. |
39 | 45 |
|
40 | 46 | --- |
41 | 47 |
|
42 | 48 | ## Authentication |
43 | 49 |
|
44 | | -Before using the iTwin CLI, authenticate your session. |
| 50 | +Before you can use the iTwin CLI, you'll need to log in. This authenticates your session and allows you to securely interact with the iTwin Platform. |
45 | 51 |
|
46 | | -Use the following command to log in: |
| 52 | +To log in, simply run: |
47 | 53 | ```bash |
48 | 54 | itp auth login |
49 | 55 | ``` |
50 | 56 |
|
51 | | -This will open a browser window for authentication. Once logged in, your session will remain active, allowing you to execute authenticated commands. |
| 57 | +This will open your default browser for authentication. Once you're logged in, your session will remain active, so you won't need to log in again for a while. |
52 | 58 |
|
53 | | -To check if you’re logged in, run: |
| 59 | +To verify your login status, run: |
54 | 60 | ```bash |
55 | 61 | itp user me |
56 | 62 | ``` |
57 | 63 |
|
58 | | -This will display your account details. |
| 64 | +This will show your account details, confirming you're properly authenticated. |
59 | 65 |
|
60 | | ---- |
| 66 | +> 💡 For more specialized authentication workflows, see [itp auth login](auth/login.md). |
61 | 67 |
|
62 | 68 | ## Quickstart |
63 | 69 |
|
64 | | -If you're new to the iTwin CLI, check out the **[Quickstart](quickstart.md)** for a step-by-step walkthrough of setting up an iTwin, creating an iModel, and adding design data. |
| 70 | +Ready to dive in? Our [Quickstart guide](quickstart.md) will walk you through the essential steps: |
| 71 | +- Creating your first iTwin |
| 72 | +- Setting up an iModel |
| 73 | +- Adding design data |
| 74 | +- Viewing your model in 3D |
| 75 | +
|
| 76 | +Perfect for new users, this guide gets you up and running in minutes. |
| 77 | +
|
| 78 | +## Simplify your commands |
| 79 | +
|
| 80 | +Want to make your commands shorter and more efficient? Our [Environment guide](environment.md) shows you how to: |
| 81 | +- Set default IDs using environment variables |
| 82 | +- Save IDs locally using the context system |
| 83 | +- Automatically save IDs when creating new iTwins and iModels |
| 84 | +
|
| 85 | +This simplifies your workflow and keeps your commands concise. |
| 86 | +
|
| 87 | +## Explore common workflows |
| 88 | +
|
| 89 | +Ready to tackle real-world scenarios? Our [workflows section](workflows/overview.md) walks you through common use cases: |
| 90 | +- ⚡ [Automate iModel updates](workflows/imodel-automate-update.md) |
| 91 | +- 📂 [Manage iTwin repositories](workflows/itwin-add-repositories.md) |
| 92 | +- 🔑 [Control user permissions](workflows/itwin-group-access.md) |
| 93 | +- 📊 [Track project progress](workflows/itwin-script-progress-tracker.md) |
| 94 | +- 🔄 [Compare changesets](workflows/imodel-changeset-compare.md) |
| 95 | +
|
| 96 | +These guides provide step-by-step instructions for specific tasks and scenarios. |
0 commit comments