Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 6 additions & 5 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@
},
"environment-setup/configuration",
"environment-setup/operations",
"environment-setup/cli",
"environment-setup/security",
"environment-setup/troubleshooting"
]
Expand Down Expand Up @@ -146,12 +147,12 @@
},
"redirects": [
{ "source": "/getting-started/overview", "destination": "/overview/tracebloc" },
{ "source": "/getting-started/quickstart", "destination": "/environment-setup/setup-guide" },
{ "source": "/getting-started/quickstart", "destination": "/environment-setup/quickstart" },
{ "source": "/getting-started/core-concepts", "destination": "/tools-help/key-terms" },
{ "source": "/getting-started/pricing", "destination": "https://tracebloc.io/#pricing" },
{ "source": "/environment-setup/deployment-guide", "destination": "/environment-setup/setup-guide" },
{ "source": "/environment-setup/local-deployment-guide-macos", "destination": "/environment-setup/setup-guide" },
{ "source": "/environment-setup/local-deployment-guide-linux", "destination": "/environment-setup/setup-guide" },
{ "source": "/environment-setup/deployment-guide", "destination": "/environment-setup/deployment-environments" },
{ "source": "/environment-setup/local-deployment-guide-macos", "destination": "/environment-setup/deploy-local" },
{ "source": "/environment-setup/local-deployment-guide-linux", "destination": "/environment-setup/deploy-local" },
{ "source": "/environment-setup/azure-deployment-guide", "destination": "/environment-setup/eks-client-deployment-guide" },
{ "source": "/environment-setup/eks-deployment-guide", "destination": "/environment-setup/eks-client-deployment-guide" },
{ "source": "/environment-setup/architecture", "destination": "/environment-setup/configuration" },
Expand All @@ -168,7 +169,7 @@
{ "source": "/collaboration/leaderboard", "destination": "/join-use-case/model-evaluation" },
{ "source": "/collaboration/prizes", "destination": "/join-use-case/overview" },
{ "source": "/create-use-case/set-evaluation", "destination": "/create-use-case/evaluate-models" },
{ "source": "/client-setup/setup-requirements", "destination": "/environment-setup/setup-guide" },
{ "source": "/client-setup/setup-requirements", "destination": "/environment-setup/quickstart" },
{ "source": "/training-guide/jupyter-notebook", "destination": "/join-use-case/start-training" },
{ "source": "/model-requirements/api-supported", "destination": "/tools-help/tracebloc" },
{ "source": "/model-requirements/model-zoo", "destination": "/create-use-case/templates" },
Expand Down
101 changes: 101 additions & 0 deletions environment-setup/cli.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
---
title: "tracebloc CLI"

Check warning on line 2 in environment-setup/cli.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

environment-setup/cli.mdx#L2

Did you really mean 'tracebloc'?
description: "Manage and operate your workspace from the command line — inspect the cluster, ingest and remove datasets, validate configs."

Check warning on line 3 in environment-setup/cli.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

environment-setup/cli.mdx#L3

Did you really mean 'configs'?
---

The `tracebloc` CLI is how you **manage and operate your workspace and its data** from your own machine: inspect the cluster, ingest datasets, remove them, validate configs — with more verbs on the way. It's the friendly front end to the same ingestion protocol the [Helm ingestor chart](https://github.com/tracebloc/client/tree/main/ingestor) speaks, so it works against any workspace running the `tracebloc/client` chart.

Check warning on line 6 in environment-setup/cli.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

environment-setup/cli.mdx#L6

Did you really mean 'configs'?

<Note>
You never touch Helm, edit YAML, or run `kubectl cp`. `dataset push` discovers your workspace, stages the files, submits, and streams the job for you.
</Note>

## Install

If you deployed with the [Quick Start](/environment-setup/quickstart) one-liner, the CLI is **already installed**. Otherwise:

<Tabs>
<Tab title="macOS / Linux">
```bash
curl -fsSL https://github.com/tracebloc/cli/releases/latest/download/install.sh | sh
```
</Tab>
<Tab title="Windows (PowerShell)">
```powershell
irm https://github.com/tracebloc/cli/releases/latest/download/install.ps1 | iex

Check warning on line 24 in environment-setup/cli.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

environment-setup/cli.mdx#L24

Did you really mean 'irm'?

Check warning on line 24 in environment-setup/cli.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

environment-setup/cli.mdx#L24

Did you really mean 'iex'?
```
</Tab>
</Tabs>

Binaries are cosign-signed and multi-arch. Pin a version with `--version vX.Y.Z` (or `$env:RELEASE_VERSION` on Windows). Verify:
```bash
tracebloc version
```

## Operate your workspace

```bash
tracebloc cluster info
```
Shows the cluster, namespace, parent release, and ingestor-token state — your first check that the CLI can reach your workspace.

Check warning on line 39 in environment-setup/cli.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

environment-setup/cli.mdx#L39

Did you really mean 'namespace'?

<Note>
If `cluster info` reports *"no parent client release found in namespace default"*, your client runs in another namespace — add `-n <your-namespace>`, or set it once with `kubectl config set-context --current --namespace <your-namespace>`. Every command below accepts `-n`.

Check warning on line 42 in environment-setup/cli.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

environment-setup/cli.mdx#L42

Did you really mean 'namespace'?

Check warning on line 42 in environment-setup/cli.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

environment-setup/cli.mdx#L42

Did you really mean 'namespace'?
</Note>

## Manage data

**Ingest a dataset** — stage local data into your workspace and run ingestion in one step:
```bash
tracebloc dataset push ./train.csv \
--category tabular_classification \
--table my_dataset_train \
--intent train \
--label-column label
```
Omit the flags to run **guided** (the CLI prompts you), or add `--dry-run` to preview without submitting. Under the hood it discovers your workspace, validates the schema locally, mints a token, stages the files to the shared volume, submits, and watches the job.

It covers 9 task categories: `image_classification`, `object_detection`, `keypoint_detection`, `text_classification`, `masked_language_modeling`, `tabular_classification`, `tabular_regression`, `time_series_forecasting`, `time_to_event_prediction`.

**Remove a dataset** — delete its table and staged files:
```bash
tracebloc dataset rm my_dataset_train
```

## Validate a config locally

```bash
tracebloc ingest validate ingest.yaml
```
Checks an `ingest.yaml` against the embedded schema — no cluster required. The declarative form (also accepted by the Helm ingestor chart):

Check warning on line 69 in environment-setup/cli.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

environment-setup/cli.mdx#L69

Did you really mean 'ingestor'?
```yaml
apiVersion: tracebloc.io/v1
kind: IngestConfig
category: tabular_classification
table: my_dataset_train
intent: train
csv: /data/shared/my_dataset/train.csv
label: label
```

## Command reference

| Command | Does |
|---|---|
| `tracebloc dataset push <path>` | Stage + ingest a local dataset (guided if you omit flags) |
| `tracebloc dataset rm <table>` | Delete a pushed dataset (table + staged files) |
| `tracebloc cluster info` | Cluster, namespace, parent release, and token state |

Check warning on line 86 in environment-setup/cli.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

environment-setup/cli.mdx#L86

Did you really mean 'namespace'?
| `tracebloc ingest validate <path>` | Validate an `ingest.yaml` against the v1 schema, locally |
| `tracebloc version` | CLI version, git SHA, and build date |
| `tracebloc completion` | Generate shell completion |

Add `--help` to any command for the full flag list. For workspace lifecycle (upgrade, stop/start, uninstall), see [Operations](/environment-setup/operations).

## CLI or Helm chart?

Both submit to the same ingestion protocol — pick the one that fits your workflow:
- **CLI** — local data on your workstation; the everyday choice. Handles staging and submission for you.
- **[Helm ingestor chart](https://github.com/tracebloc/client/tree/main/ingestor)** — Kubernetes-native / GitOps, when your data is already staged on the cluster.

## Coming soon

Cloud-source ingestion (S3 / GCS / HTTPS) for large datasets, a `dataset list` verb, and `semantic_segmentation` support.
4 changes: 4 additions & 0 deletions environment-setup/operations.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
---
title: "Operations"
description: "Run, monitor, upgrade, and maintain a tracebloc workspace day to day."

Check warning on line 3 in environment-setup/operations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

environment-setup/operations.mdx#L3

Did you really mean 'tracebloc'?
---

Everything you do *after* your workspace is running. Commands assume the default namespace `tracebloc` — substitute yours if you changed it.

Check warning on line 6 in environment-setup/operations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

environment-setup/operations.mdx#L6

Did you really mean 'namespace'?

<Note>
Day-to-day management — inspecting the cluster, ingesting and removing data — is easiest with the [tracebloc CLI](/environment-setup/cli). The Helm/kubectl commands here cover the lifecycle bits the CLI doesn't (upgrade, stop/start, uninstall) and deeper debugging.

Check warning on line 9 in environment-setup/operations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

environment-setup/operations.mdx#L9

Did you really mean 'tracebloc'?
</Note>

## Which version am I on?

```bash
Expand Down Expand Up @@ -64,18 +68,18 @@
<Tabs>
<Tab title="Local / k3d">
```bash
k3d cluster delete tracebloc # removes the cluster and your workspace

Check warning on line 71 in environment-setup/operations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

environment-setup/operations.mdx#L71

Did you really mean 'tracebloc'?
```
</Tab>
<Tab title="Helm (any cluster)">
```bash
helm uninstall tracebloc -n tracebloc

Check warning on line 76 in environment-setup/operations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

environment-setup/operations.mdx#L76

Did you really mean 'tracebloc'?
```
</Tab>
</Tabs>

PVCs are annotated `helm.sh/resource-policy: keep`, so your data survives an uninstall. To remove it too: `kubectl delete pvc --all -n tracebloc`.

Check warning on line 81 in environment-setup/operations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

environment-setup/operations.mdx#L81

Did you really mean 'PVCs'?

## Back up

Your data lives in the data PVCs (or `~/.tracebloc` on a local install). Back up that directory / those volumes on your normal schedule — tracebloc keeps nothing of yours off your infrastructure.

Check warning on line 85 in environment-setup/operations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

environment-setup/operations.mdx#L85

Did you really mean 'PVCs'?

Check warning on line 85 in environment-setup/operations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tracebloc) - vale-spellcheck

environment-setup/operations.mdx#L85

Did you really mean 'tracebloc'?
Loading