generated from mintlify/starter
-
Notifications
You must be signed in to change notification settings - Fork 59
feat(adk): add docs #329
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.
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
Draft
adkah
wants to merge
7
commits into
master
Choose a base branch
from
ak-adk
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
feat(adk): add docs #329
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
9950be2
wip
adkah 8c2e3ef
revise and correct concept guides
adkah 4df6b45
additional fixes
adkah 3a65312
add callout for workflows
adkah 095f82d
add tools page in concepts
adkah 43621a3
add reference for each concept
adkah ac8ceed
fix vale errors
adkah File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -27,4 +27,9 @@ uncheck | |
| onboarding | ||
| typing | ||
| typings | ||
| callout | ||
| callout | ||
| npm | ||
| pnpm | ||
| yarn | ||
| bun | ||
| dev | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,194 @@ | ||
| --- | ||
| title: CLI reference | ||
| description: All commands and flags available with the ADK CLI. | ||
| --- | ||
|
|
||
| The ADK CLI provides commands for creating, developing, building, and deploying Botpress agents. | ||
|
|
||
| ## Global flags | ||
|
|
||
| These flags are available for all commands: | ||
|
|
||
| | Flag | Alias | Description | | ||
| |------|-------|-------------| | ||
| | `--verbose` | `-v` | Enable verbose logging | | ||
| | `--help` | `-h` | Show help information | | ||
|
|
||
| ## Commands | ||
|
|
||
| ### `adk init` | ||
|
|
||
| Initialize a new ADK agent project. | ||
|
|
||
| **Usage:** | ||
| ```bash | ||
| adk init my-agent | ||
| adk init my-agent --template hello-world | ||
| ``` | ||
|
|
||
| **Arguments:** | ||
|
|
||
| | Argument | Description | | ||
| |----------|-------------| | ||
| | `project-name` | Name of the project directory to create | | ||
|
|
||
| **Flags:** | ||
|
|
||
| | Flag | Description | Default | | ||
| |------|-------------|---------| | ||
| | `--template` | Template to use: `blank` or `hello-world` | `blank` | | ||
| | `--package-manager` | Package manager: `npm`, `pnpm`, `yarn`, or `bun` | `bun` | | ||
|
|
||
| --- | ||
|
|
||
| ### `adk dev` | ||
|
|
||
| Start the development server with hot reloading. | ||
|
|
||
| **Usage:** | ||
| ```bash | ||
| adk dev | ||
| ``` | ||
|
|
||
| **Flags:** | ||
|
|
||
| | Flag | Description | Default | | ||
| |------|-------------|---------| | ||
| | `--port` | Port for the development server | `3000` | | ||
| | `--source-map` | Generate source maps for debugging | `true` | | ||
|
|
||
| **Description:** | ||
|
|
||
| The `dev` command: | ||
| 1. Generates TypeScript types for your integrations | ||
| 2. Builds your agent | ||
| 3. Starts a local development server | ||
| 4. Watches for file changes and automatically rebuilds | ||
|
|
||
| You'll be prompted to authenticate with Botpress Cloud if you haven't already. | ||
|
|
||
| --- | ||
|
|
||
| ### `adk build` | ||
|
|
||
| Build your agent for production. | ||
|
|
||
| **Usage:** | ||
| ```bash | ||
| adk build | ||
| ``` | ||
|
|
||
| **Flags:** | ||
|
|
||
| | Flag | Description | Default | | ||
| |------|-------------|---------| | ||
| | `--source-map` | Generate source maps | `true` | | ||
|
|
||
| **Description:** | ||
|
|
||
| Compiles your agent and creates an optimized build in the `.botpress/dist` directory. The build includes: | ||
| - Compiled TypeScript code | ||
| - Bundled dependencies | ||
| - Generated type definitions | ||
| - Source maps (if enabled) | ||
|
|
||
| --- | ||
|
|
||
| ### `adk deploy` | ||
|
|
||
| Deploy your agent to Botpress Cloud. | ||
|
|
||
| **Usage:** | ||
| ```bash | ||
| adk deploy | ||
| ``` | ||
|
|
||
| **Flags:** | ||
|
|
||
| | Flag | Description | Default | | ||
| |------|-------------|---------| | ||
| | `--bot-id` | Bot ID to deploy to (creates new bot if not provided) | | | ||
| | `--no-build` | Skip the build step | `false` | | ||
|
|
||
| **Description:** | ||
|
|
||
| Deploys your agent to your Botpress workspace. If no `--bot-id` is provided, a new bot will be created. The command will: | ||
| 1. Build your agent (unless `--no-build` is specified) | ||
| 2. Upload the built agent to Botpress Cloud | ||
| 3. Make your agent available for use | ||
|
|
||
| --- | ||
|
|
||
| ### `adk add` | ||
|
|
||
| Add an integration to your agent project. | ||
|
|
||
| **Usage:** | ||
| ```bash | ||
| adk add webchat | ||
| adk add slack@latest | ||
| adk add my-workspace/[email protected] | ||
| ``` | ||
|
|
||
| **Arguments:** | ||
|
|
||
| | Argument | Description | | ||
| |----------|-------------| | ||
| | `integration` | Integration name with optional version (e.g., `webchat@latest` or `[email protected]`) | | ||
|
|
||
| **Description:** | ||
|
|
||
| Adds an integration to your `dependencies.json` file and generates TypeScript types for it. The integration is automatically enabled by default. | ||
|
|
||
| **Examples:** | ||
|
|
||
| - `adk add webchat` - Add latest webchat integration | ||
| - `adk add [email protected]` - Add specific version of Slack integration | ||
| - `adk add my-workspace/custom@latest` - Add integration from a specific workspace | ||
|
|
||
| --- | ||
|
|
||
| ### `adk chat` | ||
|
|
||
| Chat with your deployed bot directly from the CLI. | ||
|
|
||
| **Usage:** | ||
| ```bash | ||
| adk chat my-bot-id | ||
| ``` | ||
|
|
||
| **Arguments:** | ||
|
|
||
| | Argument | Description | | ||
| |----------|-------------| | ||
| | `bot-id` | Bot ID to chat with | | ||
|
|
||
| **Description:** | ||
|
|
||
| Opens an interactive chat session with your deployed bot. Useful for testing your agent's responses. | ||
|
|
||
| --- | ||
|
|
||
| ## Project scripts | ||
|
|
||
| The ADK also provides npm scripts that you can use in your `package.json`: | ||
|
|
||
| ```json | ||
| { | ||
| "scripts": { | ||
| "dev": "adk dev", | ||
| "build": "adk build", | ||
| "deploy": "adk deploy" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| Run these with your package manager: | ||
|
|
||
| ```bash | ||
| npm run dev | ||
| bun run dev | ||
| pnpm dev | ||
| yarn dev | ||
| ``` | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.