Skip to content

auto-update(docs) - feat(cli): add portable project import/export #495

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
charmenta wants to merge 1 commit into
base: master
Choose a base branch
from
Open

auto-update(docs) - feat(cli): add portable project import/export #495

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
46 changes: 46 additions & 0 deletions adk/cli-reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,6 +394,52 @@ Manage static files your agent serves or references:
| `adk assets status` | Show asset sync status |
| `adk assets pull` | Download remote assets to local directory |

## Portability

These commands move a project between workspaces or users as a self-contained archive:

| Command | Description |
|---------|-------------|
| `adk export [output]` | Export the current project as a portable `.adk` archive |
| `adk import <archive> [directory]` | Import a `.adk` archive and link it to new bots |

### `adk export`

Export the current project, including its dependency snapshots, as a portable archive. Source bot, workspace, and account IDs are excluded. By default the output is named after the project:

```bash
adk export
adk export my-agent.adk
adk export --no-config
```

| Flag | Description |
|------|-------------|
| `--no-config` | Omit integration and plugin configuration from dependency snapshots |
| `--format <format>` | Output format (`json`) |

Exported snapshots include all integration and plugin configuration, which may contain secrets. Only share the `.adk` archive with trusted recipients, or use `--no-config` to exclude configuration.

### `adk import`

Import a `.adk` archive into a new directory, restore its dependencies, and link it to bots in the destination workspace. Existing bots can be reused, or new ones are created automatically:

```bash
adk import my-agent.adk
adk import my-agent.adk ./my-agent
adk import my-agent.adk --workspace wkspace_123 --force
```

| Flag | Description |
|------|-------------|
| `--workspace <workspaceId>` | Destination workspace ID |
| `--bot <botId>` | Destination production bot ID |
| `--dev <devBotId>` | Destination dev bot ID |
| `--api-url <apiUrl>` | Botpress API URL |
| `-f, --force` | Skip confirmation prompts |
| `--package-manager <packageManager>` | Package manager to install dependencies (`bun`, `pnpm`, `yarn`, `npm`) |
| `--format <format>` | Output format (`json`) |

### `adk assets sync`

Upload local assets to remote storage. Use `--dry-run` to see what would change:
Expand Down
Loading