Skip to content

Commit 4b547e6

Browse files
authored
Roopksaini/improved landing+quickstart (#113)
* updated-quickstart * polished-landing-page * workflow-update * fixed-over-bolding * link-update
1 parent 8ce00f0 commit 4b547e6

5 files changed

Lines changed: 87 additions & 43 deletions

File tree

docs/README.md

Lines changed: 52 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,96 @@
1-
# iTwin CLI Manual
1+
# Welcome to iTwin CLI
22

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.
46
57
## What is the iTwin CLI?
68

79
The iTwin CLI enables users to:
810

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
1316

1417
Whether you're a first-time user or an experienced developer, this CLI provides essential commands to optimize your iTwin workflows.
1518

1619
---
1720

1821
## Installation
1922

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:
2124

2225
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.
2427

2528
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.
2832
- **Linux**: Extract the `.tar.gz` file and run:
2933
```bash
3034
sudo ./install.sh
3135
```
3236

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:
3539
```bash
3640
itp --version
3741
```
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.
3945
4046
---
4147
4248
## Authentication
4349
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.
4551

46-
Use the following command to log in:
52+
To log in, simply run:
4753
```bash
4854
itp auth login
4955
```
5056

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.
5258

53-
To check if you’re logged in, run:
59+
To verify your login status, run:
5460
```bash
5561
itp user me
5662
```
5763

58-
This will display your account details.
64+
This will show your account details, confirming you're properly authenticated.
5965
60-
---
66+
> 💡 For more specialized authentication workflows, see [itp auth login](auth/login.md).
6167
6268
## Quickstart
6369
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.

docs/_sidebar.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
* [iTwin CLI Manual](/docs/)
1+
* [iTwin CLI](/docs/)
22
* [iTwin 101](/docs/itwin101.md)
33
* [Quickstart](/docs/quickstart.md)
44
* [Environment](/docs/environment.md)

docs/itwin101.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -67,14 +67,14 @@ Need to connect to a custom database, web API, or document store? The iTwin is d
6767

6868
The **iTwin CLI** is a command-line tool that lets developers and technical users interact with the iTwin Platform through simple text commands. It simplifies many common tasks:
6969

70-
- ✍️ **Create and manage iTwins**
71-
- 🛡️ **Set up access control and user roles**
72-
- 🔍 **Query or inspect metadata**
73-
- 📂 **Create iModels and populate them with design files**
74-
- 📰 **Track and compare changes with changesets**
75-
- 🔢 **Create named versions to mark project milestones**
76-
-**Synchronize design data into the iModel**
77-
- 🌍 **Visualize the iTwin in Cesium Sandcastle**
70+
- ✍️ Create and manage iTwins
71+
- 🛡️ Set up access control and user roles
72+
- 🔍 Query or inspect metadata
73+
- 📂 Create iModels and populate them with design files
74+
- 📰 Track and compare changes with changesets
75+
- 🔢 Create named versions to mark project milestones
76+
- ⇄ Synchronize design data into the iModel
77+
- 🌍 Visualize the iTwin in Cesium Sandcastle
7878

7979
It serves as a lightweight, scriptable gateway into a powerful ecosystem.
8080

docs/quickstart.md

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
The iTwin CLI allows you to interact with the iTwin Platform efficiently. This guide walks you through the essential first steps: **creating an iTwin, setting up an iModel, and populating it with design data.**
44

5+
> 💡 New to iTwins? Check out our [iTwin 101 guide](itwin101.md) for an introduction to the platform.
6+
57
## Get Started with the iTwin Platform
68

79
### Step 0: Authenticate
@@ -16,41 +18,47 @@ itp auth login
1618

1719
### Step 1: Create an iTwin
1820

19-
An iTwin represents a **digital twin** that organizes models, repositories, and data sources.
21+
An iTwin represents a **digital twin** that organizes models, repositories, and data sources. We'll use the `--save` flag to store the iTwin ID for future commands.
2022

2123
```bash
22-
itp itwin create --class Thing --sub-class Asset --name "My First iTwin"
24+
itp itwin create --class Thing --sub-class Asset --name "My First iTwin" --save
2325
```
2426

25-
**Result:** The command returns an *iTwin ID*, which you'll use in the next steps.
26-
27-
---
27+
**Result:** The command returns an *iTwin ID* and automatically saves it for future use. You won't need to specify this ID in subsequent commands.
2828

2929
### Step 2: Create an iModel
3030

31-
An iModel stores design data and tracks changes over time. To create one, specify the *iTwin ID* from Step 1.
31+
An iModel stores design data and tracks changes over time. We'll create one within our iTwin, and once again use the `--save` flag to store its ID for future commands.
3232

3333
> Need a design file? Feel free to use the examples provided in the [iTwin CLI repository](https://github.com/iTwin/itwin-cli/tree/main/examples/datasets).
3434
3535
```bash
36-
itp imodel create --itwin-id your-itwin-id --name "My First iModel"
36+
itp imodel create --name "My First iModel" --save
3737
```
3838

39-
**Result:** You receive an *iModel ID* for future operations.
40-
41-
---
39+
**Result:** You receive an *iModel ID* which is automatically saved for future use.
4240

4341
### Step 3: Populate the iModel with Design Data
4442

45-
Once your iModel is created, synchronize design files into it using the **populate** command.
43+
The populate command populates an iModel with design data from a given set of files. Since we already saved our iModel ID, we only need to specify the source file(s).
4644

4745
```bash
48-
itp imodel populate --imodel-id your-imodel-id --file file.dgn
46+
itp imodel populate --file file.dgn
4947
```
5048

5149
**Result:** Your design data is now available on the iTwin Platform. You can navigate to [My iTwins](https://developer.bentley.com/my-itwins/) on the iTwin Developer Portal to visualize it.
5250

53-
---
51+
### Step 4: View in Cesium Sandcastle (Bonus)
52+
53+
Want to view your iModel in 3D? The CLI opens it on Cesium, where you can explore it in a geospatial environment.
54+
55+
```bash
56+
itp imodel view cesium-sandcastle --open
57+
```
58+
59+
**Result:** Your default browser opens with your iModel data displayed in 3D global context. You can orbit, zoom, and explore your design data in a rich geospatial environment.
60+
61+
> 💡 Learn more about managing your iTwin and iModel IDs in our [Environment guide](environment.md).
5462
5563
## Next Steps
5664

@@ -63,4 +71,4 @@ itp imodel populate --imodel-id your-imodel-id --file file.dgn
6371

6472
---
6573

66-
🎉 **Congratulations!** You've successfully created an iTwin, set up an iModel, and populated it with data. Now you're ready to dive deeper into automation and integration!
74+
🎉 **Congratulations!** You've successfully created an iTwin, set up an iModel, populated it with data, and even viewed it in 3D. Now you're ready to dive deeper into iTwin workflows and automation!

docs/workflows/overview.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Workflows
22

3+
Ready to put the iTwin CLI to work? These guides show you how to handle common tasks like project setup, team management, and automation.
4+
5+
> 💡 The following are a few of the many possibilities.
6+
37
**Getting Started**
48
- [Create and refine an iTwin](itwin-create.md)
59
- [Create and refine an iModel](imodel-create.md)

0 commit comments

Comments
 (0)