> ## Documentation Index
> Fetch the complete documentation index at: https://docs.linkmodel.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Started

> Use the official LinkModel CLI to generate images and videos from your terminal, scripts, and automation workflows.

The LinkModel CLI is the official command-line client for LinkModel. Use it to create generation tasks, poll task status, download artifacts, inspect model schemas, and automate image or video generation from your terminal.

## Guides

<CardGroup cols={2}>
  <Card title="Installation" icon="download" href="/cli-installation">
    Install the CLI, verify the command, and choose between `lkm` and `linkmodel`.
  </Card>

  <Card title="Authentication" icon="key" href="/cli-authentication">
    Configure API keys for local use, CI jobs, and one-off commands.
  </Card>

  <Card title="Image Generation" icon="image" href="/cli-image-generation">
    Generate images, pass reference images, and download output files.
  </Card>

  <Card title="Video Generation" icon="video" href="/cli-video-generation">
    Generate videos, set duration and resolution, and resume long-running tasks.
  </Card>

  <Card title="Model Schemas" icon="box" href="/cli-model-schemas">
    Inspect bundled model parameters before choosing CLI flags.
  </Card>

  <Card title="Automation" icon="terminal" href="/cli-automation">
    Use JSON output, exit codes, and task status commands in scripts.
  </Card>

  <Card title="Troubleshooting" icon="circle-question" href="/cli-troubleshooting">
    Diagnose authentication, parameter, timeout, and download issues.
  </Card>
</CardGroup>

## Common Workflow

Install and authenticate once:

```bash theme={null}
npm install -g linkmodel-cli
lkm setup
```

Generate an image:

```bash theme={null}
lkm image "a product photo on a clean studio background"
```

Generate a video:

```bash theme={null}
lkm video "a cinematic product orbit"
```

Inspect model-specific flags:

```bash theme={null}
lkm models show kling-v3
```

## Command Names

The package installs two command names:

| Command     | Description                               |
| ----------- | ----------------------------------------- |
| `lkm`       | Short command used throughout these docs. |
| `linkmodel` | Descriptive alias with the same behavior. |

## Resources

* GitHub: [linkmodelhq/linkmodel-cli](https://github.com/linkmodelhq/linkmodel-cli)
* npm: [linkmodel-cli](https://www.npmjs.com/package/linkmodel-cli)