Skip to content

docs: Update carbidecli references to nicocli in quick-start guide #1718

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kfelternv wants to merge 4 commits into
base: main
Choose a base branch
from
+8 −8
Open

docs: Update carbidecli references to nicocli in quick-start guide #1718

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
661d548
docs: Update carbidecli references to nicocli in quick-start guide
kfelternv May 15, 2026
c4a4877
Merge branch 'main' into docs-carbidecli-to-nicocli
kfelternv May 15, 2026
17b1212
Merge branch 'main' into docs-carbidecli-to-nicocli
kfelternv May 19, 2026
f520d3a
Merge branch 'main' into docs-carbidecli-to-nicocli
kfelternv May 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/getting-started/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -413,28 +413,28 @@ kubectl run -i --rm --restart=Never --image=curlimages/curl curl-test \
-H "Authorization: Bearer $TOKEN"
```

### Set up carbidecli and Create your First Site
### Set up nicocli and Create your First Site

NICo has two CLIs that serve different purposes:

| CLI | Communicates with | Used for |
|---|---|---|
| `carbidecli` | NICo REST (REST API) | Site management, org bootstrap, instance operations |
| `nicocli` | NICo REST (REST API) | Site management, org bootstrap, instance operations |
| `carbide-admin-cli` | NICo Core (gRPC API) | Host ingestion, credentials, expected machines, TPM approval |

`carbidecli` is built from the NCX REST repo. `carbide-admin-cli` is built from the NCX Core repo (`crates/admin-cli`).
`nicocli` is built from the NCX REST repo. `carbide-admin-cli` is built from the NCX Core repo (`crates/admin-cli`).

#### 1. Build and Install the CLI

```bash
cd "$NCX_REPO"
make carbide-cli # installs to $(go env GOPATH)/bin/carbidecli
make nico-cli # installs to $(go env GOPATH)/bin/nicocli
```

#### 2. Generate the Default Config File

```bash
carbidecli init # writes ~/.carbide/config.yaml
nicocli init # writes ~/.nico/config.yaml
```

#### 3. Port-forward `carbide-rest-api` to localhost
Expand All @@ -443,7 +443,7 @@ carbidecli init # writes ~/.carbide/config.yaml
kubectl port-forward -n carbide-rest svc/carbide-rest-api 8388:8388
```

#### 4. Edit `~/.carbide/config.yaml`
#### 4. Edit `~/.nico/config.yaml`

```yaml
api:
Expand Down Expand Up @@ -476,8 +476,8 @@ curl -sS -H "Authorization: Bearer $TOKEN" \
#### 6. Create your First Site

```bash
carbidecli site create --name mysite --description 'first site'
carbidecli site list
nicocli site create --name mysite --description 'first site'
nicocli site list
```

### Overall Health Check
Expand Down
Loading