---
title: 'Flexkit CLI'
description: 'Reference and usage guidance for Flexkit CLI.'
---

# Flexkit CLI

The Flexkit CLI lets you authenticate, manage projects, and deploy schema updates from your terminal.

## Install

**pnpm**

```sh
pnpm add -g @flexkit/cli
```

**npm**

```sh
npm install -g @flexkit/cli
```

**yarn**

```sh
yarn add -g @flexkit/cli
```

**bun**

```sh
bun add -g @flexkit/cli
```

## Updating Flexkit CLI

The easiest way to update the Flexkit CLI is by running the installation command yet again.

**pnpm**

```sh
pnpm add -g @flexkit/cli@latest
```

**npm**

```sh
npm install -g @flexkit/cli@latest
```

**yarn**

```sh
yarn add -g @flexkit/cli@latest
```

**bun**

```sh
bun add -g @flexkit/cli@latest
```

## Usage

```bash
flexkit [options] <command>
```

## Available Commands

- `assets`: Manage project assets (`upload`, `export`).
- `deploy`: Deploy the current schema and observe progress in real time.
- `export`: Export the full dataset (entities + assets) to a tarball.
- `import`: Import entities and assets from NDJSON, a directory or a tarball.
- `project`: Manage projects (`ls`, `add`, `rm`).
- `login`: Authenticate your CLI session.
- `logout`: Remove local credentials and log out.
- `whoami`: Print the currently authenticated user.
- `help`: Show usage for the CLI or a specific command.

## Command Reference

- [Global options and auth behavior](/docs/cli/global-options)
- [assets](/docs/cli/assets)
- [deploy](/docs/cli/deploy)
- [export](/docs/cli/export)
- [import](/docs/cli/import)
- [project](/docs/cli/project)
- [login](/docs/cli/login)
- [logout](/docs/cli/logout)
- [whoami](/docs/cli/whoami)
- [help](/docs/cli/help)


---

[View full sitemap](/docs/sitemap.md)