Skip to content

docs: point Dataset CLI to lmnr-cli (LAM-1786) #179

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

Merged
olzhik11 merged 2 commits into from
Jul 16, 2026
Merged

docs: point Dataset CLI to lmnr-cli (LAM-1786) #179

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
105a01d
docs: point Dataset CLI to lmnr-cli (LAM-1786)
kolbeyang Jun 17, 2026
7d48221
docs: use lmnr-cli setup for auth (it includes login)
kolbeyang Jun 17, 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
220 changes: 58 additions & 162 deletions datasets/cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,23 @@ sidebarTitle: CLI
title: Laminar datasets CLI
---

The `lmnr datasets` command is used to manage datasets in Laminar. For full CLI documentation visit [here](/platform/cli).
The `lmnr-cli dataset` command manages datasets in Laminar from your terminal: list them, create new ones from local files, and push or pull datapoints. It ships in the standalone [`lmnr-cli`](/platform/cli) npm package, so you do not need the `@lmnr-ai/lmnr` SDK installed to use it.

<Note>
`lmnr-cli` replaces the dataset commands that used to ship with the `@lmnr-ai/lmnr` SDK (`lmnr datasets ...`). The old SDK-bundled CLI is deprecated; use `lmnr-cli dataset` instead.
</Note>

## Install

```bash
# Run directly with npx (no install)
npx lmnr-cli@latest dataset list

# Or install globally
npm install -g lmnr-cli
```

The rest of this page assumes a global install (`lmnr-cli dataset ...`). With `npx`, prefix each command with `npx lmnr-cli@latest`.

## Usage

Expand Down Expand Up @@ -46,32 +62,23 @@ data,target
</Expandable>
</Step>

<Step title="Set the project API key">
<Step title="Authenticate and link your project">

```bash
export LMNR_PROJECT_API_KEY=<your-project-api-key>
```

Alternatively, you can set it in the `.env` file in the same directory where you run the CLI.
The CLI authenticates as you, the signed-in user. Run `lmnr-cli setup` once in your project: it logs you in (opens a browser to authorize the CLI) and links the current directory to a project by writing `.lmnr/project.json`. Every dataset command then runs against that linked project.

```bash
echo "\nLMNR_PROJECT_API_KEY=<your-project-api-key>" >> .env
lmnr-cli setup
```

Or, you can also pass the `--project-api-key` flag to the global datasets command, e.g.
Alternatively, target a project explicitly with `--project-id` on any command:

<Tabs>
<Tab title="JavaScript/TypeScript">
```bash
npx lmnr datasets --project-api-key "<your-project-api-key>" list
```
</Tab>
<Tab title="Python">
```bash
lmnr datasets --project-api-key "<your-project-api-key>" list
lmnr-cli dataset --project-id <your-project-id> list
```
</Tab>
</Tabs>

<Note>
Unlike the old SDK-bundled CLI, `lmnr-cli` does not use a project API key. See [Authenticate](/platform/cli#authenticate) and [Directory-scoped projects](/platform/cli#directory-scoped-projects) for details.
</Note>
</Step>

<Step title="Create a new dataset">
Expand All @@ -82,18 +89,9 @@ The datapoints are saved to a new file in order to:
- Store datasets in the Laminar format. In particular, datapoint id is crucial for versioning ([Learn more](/datasets/introduction#versioning)).
- Not overwrite existing files.

<Tabs>
<Tab title="JavaScript/TypeScript">
```bash
npx lmnr datasets create my-cli-dataset data.json -o my-cli-dataset.json
lmnr-cli dataset create my-cli-dataset data.json -o my-cli-dataset.json
```
</Tab>
<Tab title="Python">
```bash
lmnr datasets create my-cli-dataset data.json -o my-cli-dataset.json
```
</Tab>
</Tabs>
</Step>

<Step title="Work on the dataset locally">
Expand All @@ -111,37 +109,19 @@ This is because the push operation only pushes new datapoint (versions) to the d
<Step title="Push the changes to Laminar">
Push the changes to Laminar.

<Tabs>
<Tab title="JavaScript/TypeScript">
```bash
npx lmnr datasets push -n my-cli-dataset my-cli-dataset.json
```
</Tab>
<Tab title="Python">
```bash
lmnr datasets push -n my-cli-dataset my-cli-dataset.json
lmnr-cli dataset push my-cli-dataset.json -n my-cli-dataset
```
</Tab>
</Tabs>

This will push the changes to the dataset in Laminar.
</Step>

<Step title="Pull the changes from Laminar">
If you need to update the local dataset with the latest changes from Laminar, you can pull the changes.

<Tabs>
<Tab title="JavaScript/TypeScript">
```bash
npx lmnr datasets pull -n my-cli-dataset my-cli-dataset.json
lmnr-cli dataset pull my-cli-dataset.json -n my-cli-dataset
```
</Tab>
<Tab title="Python">
```bash
lmnr datasets pull -n my-cli-dataset my-cli-dataset.json
```
</Tab>
</Tabs>

This will pull the changes from the dataset in Laminar to the local file `my-cli-dataset.json`.

Expand All @@ -155,67 +135,30 @@ This will overwrite the contents of the current file `my-cli-dataset.json`.
### Working on an existing dataset

<Steps>
<Step title="Set the project API key">

```bash
export LMNR_PROJECT_API_KEY=<your-project-api-key>
```

Alternatively, you can set it in the `.env` file in the same directory where you run the CLI.
<Step title="Authenticate and link your project">

```bash
echo "\nLMNR_PROJECT_API_KEY=<your-project-api-key>" >> .env
```
Run `lmnr-cli setup` once to log in and link the current directory to your project (see [above](#creating-a-new-dataset-and-iterating-on-it)):

Or, you can also pass the `--project-api-key` flag to the global datasets command, e.g.

<Tabs>
<Tab title="JavaScript/TypeScript">
```bash
npx lmnr datasets --project-api-key "<your-project-api-key>" list
lmnr-cli setup
```
</Tab>
<Tab title="Python">
```bash
lmnr datasets --project-api-key "<your-project-api-key>" list
```
</Tab>
</Tabs>

</Step>
<Step title="Select the dataset to work on">

List all datasets and select the one you want to work on.

<Tabs>
<Tab title="JavaScript/TypeScript">
```bash
npx lmnr datasets list
```
</Tab>
<Tab title="Python">
```bash
lmnr datasets list
lmnr-cli dataset list
```
</Tab>
</Tabs>
</Step>

<Step title="Pull the data from Laminar">
Pull the data from Laminar to a local file.

<Tabs>
<Tab title="JavaScript/TypeScript">
```bash
npx lmnr datasets pull -n my-dataset my-dataset.json
lmnr-cli dataset pull my-dataset.json -n my-dataset
```
</Tab>
<Tab title="Python">
```bash
lmnr datasets pull -n my-dataset my-dataset.json
```
</Tab>
</Tabs>

This will pull the changes from the dataset in Laminar to the local file `my-dataset.json`.

Expand All @@ -239,54 +182,43 @@ This is because the push operation only pushes new datapoint (versions) to the d
<Step title="Push the changes to Laminar">
Push the changes to Laminar.

<Tabs>
<Tab title="JavaScript/TypeScript">
```bash
npx lmnr datasets push -n my-dataset my-dataset.json
```
</Tab>
<Tab title="Python">
```bash
lmnr datasets push -n my-dataset my-dataset.json
lmnr-cli dataset push my-dataset.json -n my-dataset
```
</Tab>
</Tabs>

This will push the changes to the dataset in Laminar.
</Step>
</Steps>

### Setting the CLI to call a local Laminar instance

Global `datasets` command has optional arguments:
The `dataset` command has optional arguments for pointing at a self-hosted instance:

- `--base-url`: The base URL of the Laminar instance. Do NOT include port here. Default is `https://api.lmnr.ai`.
- `--port`: The HTTP port of the Laminar instance. Default is 443. For local self-hosted Laminar, use 8000.
- `--project-api-key`: The API key of the project. If not provided, reads from `LMNR_PROJECT_API_KEY` environment variable.
- `--base-url`: The base URL of the Laminar instance. Do NOT include port here. Default is `https://api.lmnr.ai` (or the `LMNR_BASE_URL` env variable).
- `--port`: The HTTP port of the Laminar instance. Default is 443 (or the `LMNR_HTTP_PORT` env variable). For local self-hosted Laminar, use 8000.
- `--project-id`: The id of the project to target. If not provided, resolves from the nearest `.lmnr/project.json`.

## Reference

<Tabs>
<Tab title="JavaScript/TypeScript">
```bash
npx lmnr datasets [command]
lmnr-cli dataset --base-url http://localhost --port 8000 list
```
</Tab>
<Tab title="Python">

See [Self-hosting](/platform/cli#self-hosting) for the full self-hosted setup.

## Reference

```bash
lmnr datasets [command]
lmnr-cli dataset [command]
```
</Tab>
</Tabs>

## General options

These are useful if you want to call a local Laminar instance.
These are shared by every `dataset` subcommand.

```
--project-api-key <key> Project API key. If not provided, reads from LMNR_PROJECT_API_KEY env variable
--base-url <url> Base URL for the Laminar API. Defaults to https://api.lmnr.ai or LMNR_BASE_URL env variable
--port <port> Port for the Laminar API. Defaults to 443
--project-id <id> Target project id. Defaults to the linked .lmnr/project.json
--base-url <url> Base URL for the Laminar API. Defaults to https://api.lmnr.ai or LMNR_BASE_URL env variable
--port <port> Port for the Laminar API. Defaults to 443 or LMNR_HTTP_PORT env variable
--json Output structured JSON to stdout
```

## Commands
Expand All @@ -295,43 +227,25 @@ These are useful if you want to call a local Laminar instance.

List all datasets.

<Tabs>
<Tab title="JavaScript/TypeScript">
```bash
npx lmnr datasets list
lmnr-cli dataset list
```
</Tab>
<Tab title="Python">
```bash
lmnr datasets list
```
</Tab>
</Tabs>

### Create a new dataset

Create a dataset from input files.

<Tabs>
<Tab title="JavaScript/TypeScript">
```bash
npx lmnr datasets create [options] <name> <paths...>
```
</Tab>
<Tab title="Python">
```bash
lmnr datasets create [options] <name> <paths...>
lmnr-cli dataset create [options] <name> <paths...>
```
</Tab>
</Tabs>

```
Arguments:
name Name of the dataset to create
paths Paths to files or directories containing data to push

Options:
-o, --output-file <file> Path to save the pulled data
-o, --output-file <file> Path to save the pulled data (required)
--output-format <format> Output format (json, csv, jsonl). Inferred from file extension if not provided
-r, --recursive Recursively read files in directories (default: false)
--batch-size <size> Batch size for pushing/pulling data (default: 100)
Expand All @@ -341,18 +255,9 @@ Options:

Push datapoints to an existing dataset from a file or files.

<Tabs>
<Tab title="JavaScript/TypeScript">
```bash
npx lmnr datasets push -n [options] <paths...>
lmnr-cli dataset push [options] <paths...>
```
</Tab>
<Tab title="Python">
```bash
lmnr datasets push -n [options] <paths...>
```
</Tab>
</Tabs>

```
Arguments:
Expand All @@ -369,18 +274,9 @@ Options:

Pull datapoints from a dataset to a file or print them to the console.

<Tabs>
<Tab title="JavaScript/TypeScript">
```bash
npx lmnr datasets pull [options] [output-path]
```
</Tab>
<Tab title="Python">
```bash
lmnr datasets pull [options] [output-path]
lmnr-cli dataset pull [options] [output-path]
```
</Tab>
</Tabs>

```
Arguments:
Expand All @@ -393,5 +289,5 @@ Options:
--batch-size <size> Batch size for pulling data (default: 100)
--limit <limit> Limit number of datapoints to pull
--offset <offset> Offset for pagination (default: 0)
-h, --help display help for command
```
```