-
Notifications
You must be signed in to change notification settings - Fork 71
adk docs update audit #461
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
Merged
Merged
Changes from 2 commits
Commits
Show all changes
30 commits
Select commit
Hold shift + click to select a range
fc8b1df
remove default expand
adkah 22537f7
align get started section
adkah 95a4146
audit configuration guide
adkah ceb76bc
quick fix to quickstart description
adkah ce64b70
audit environment setup guide
adkah 7be95f4
audit integrations
adkah 828d32a
audit conversations/setup
adkah 7c115c6
audit ai execution guide
adkah bd96ad6
revert next steps sections
adkah 6994579
audit tools page
adkah e690a65
audit custom components
adkah ec8dde0
audit messages
adkah 971c59c
Merge remote-tracking branch 'origin/aj/adk-docs-update' into ak-aj-a…
adkah 2d81070
audit lifecycle and state
adkah 0eb4d41
audit steps
adkah 75f5a1c
audit request/notify
adkah 1fcf758
audit actions
adkah 7f0a595
fix actions description
adkah cf17191
audit triggers
adkah f631f13
audit tables
adkah 87d3796
fix
adkah bc1cca1
fix vale
adkah b0c8c69
fix vale again
adkah a6999e2
add redirects
adkah 0ed3fe9
fix links
adkah 24108a9
audit knowledge
adkah 60b34ff
fix kb description
adkah ee716ba
fix
adkah 8df10ff
docs(adk): fix accuracy issues from PR audit
jacksonyzj ae308cb
docs(adk): fix accuracy issues surfaced by end-to-end testing
jacksonyzj 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 was deleted.
Oops, something went wrong.
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,138 @@ | ||
| --- | ||
| title: Quickstart | ||
| description: This guide walks you through installing the ADK and creating your first agent project. | ||
| --- | ||
|
|
||
| By the end of this guide, you'll have a working AI agent that responds to messages on Webchat. It takes about 5 minutes. | ||
|
|
||
| <Info> | ||
| You will need: | ||
|
|
||
| * A [Botpress account](https://sso.botpress.cloud) | ||
| * [Node.js](https://nodejs.org/en) (v22.0.0 or higher) | ||
| * A supported package manager — [bun](https://bun.sh), [pnpm](https://pnpm.io), [yarn](https://yarnpkg.com) or [npm](https://www.npmjs.com) | ||
| </Info> | ||
|
|
||
| ## Installation | ||
|
|
||
| Install the ADK CLI globally: | ||
|
|
||
| <CodeGroup> | ||
| ```bash macOS & Linux theme={"theme":{"light":"light-plus","dark":"dark-plus"}} | ||
| curl -fsSL https://github.com/botpress/adk/releases/latest/download/install.sh | bash | ||
| ``` | ||
|
|
||
| ```powershell Windows (PowerShell) theme={"theme":{"light":"light-plus","dark":"dark-plus"}} | ||
| powershell -c "irm https://github.com/botpress/adk/releases/latest/download/install.ps1 | iex" | ||
| ``` | ||
| </CodeGroup> | ||
|
|
||
| Then, verify the installation: | ||
|
|
||
| ```bash theme={"theme":{"light":"light-plus","dark":"dark-plus"}} | ||
| adk --version | ||
| ``` | ||
|
|
||
| Log in to your Botpress account: | ||
|
|
||
| ```bash | ||
| adk login | ||
| ``` | ||
|
|
||
| This will open a browser window for authentication. Once complete, the CLI stores your credentials locally. | ||
|
|
||
| ## Create your agent | ||
|
|
||
| Initialize a new agent project: | ||
|
|
||
| ```bash | ||
| adk init my-agent | ||
| ``` | ||
|
|
||
| The wizard walks you through three steps: | ||
|
|
||
| 1. **Select a template**: Pick `hello-world`. This creates a simple agent that responds to webchat messages using an AI model. | ||
| 2. **Select a package manager**: We recommend [bun](https://bun.sh) for the fastest experience. npm, pnpm, and yarn also work. If you only have one installed, this step is skipped. | ||
| 3. **Link to Botpress**: Select the workspace you want to deploy to. The CLI creates a bot in that workspace and connects your project to it. | ||
|
|
||
| The CLI then automatically installs dependencies and sets up your project in the `my-agent` directory. | ||
|
|
||
| Navigate into your project: | ||
|
|
||
| ```bash | ||
| cd my-agent | ||
| ``` | ||
|
|
||
| ## Test your agent | ||
|
|
||
| Now, you’re ready to test your agent. | ||
|
|
||
| ### Start the development server | ||
|
|
||
| Start the development server with hot reloading: | ||
|
|
||
| ```bash | ||
| adk dev | ||
| ``` | ||
|
|
||
| This builds your agent, deploys it to a development bot on Botpress, and starts the dev console at [`http://localhost:3001/`](http://localhost:3001/). Press <kbd>space</kbd> in the terminal to open it in your browser. | ||
|
|
||
| ### View in the dev console | ||
|
|
||
| The dev console is your local control panel for building and debugging. Within the dev console, you can: | ||
|
|
||
| - Chat with your agent | ||
| - Browse its components (actions, workflows, triggers) | ||
| - Manage data (tables, knowledge bases, files) | ||
| - Run evals | ||
| - Inspect traces and logs | ||
| - Configure integrations | ||
|
|
||
| Go to the **Chat** page and send a message to test your agent: | ||
|
|
||
| <Frame> | ||
| <img alt="ADK dev console" className="block dark:hidden" src="./assets/quickstart.png" /> | ||
| <img alt="ADK dev console" className="hidden dark:block" src="./assets/quickstart-dark.png" /> | ||
| </Frame> | ||
|
|
||
| The dev server watches your files and rebuilds on every change. | ||
|
|
||
| ### Chat in the terminal | ||
|
|
||
| Alternatively, open a new terminal window and start a conversation with your agent from the command line: | ||
|
|
||
| ```bash | ||
| adk chat | ||
| ``` | ||
|
|
||
| ```txt | ||
| Botpress Chat | ||
| Type "exit" or press ESC key to quit | ||
| 👤 Hey! | ||
| 🤖 Hello! How can I assist you today? | ||
| >> | ||
| ``` | ||
|
|
||
| ## Deploy your agent | ||
|
|
||
| When you're ready to go live: | ||
|
|
||
| ```bash | ||
| adk deploy | ||
| ``` | ||
|
|
||
| This builds your agent for production, runs preflight checks (integration changes, config diffs), syncs your knowledge bases and tables, and uploads everything to Botpress. The CLI walks you through any changes that need approval before deploying. | ||
|
|
||
| Once deployed, your agent is live in the workspace you linked during `adk init`. | ||
|
|
||
| <Check> | ||
| You deployed your first agent using the ADK! | ||
| </Check> | ||
|
|
||
| ## Next steps | ||
|
|
||
| Next, learn what's in the project you just created and how to configure it: | ||
|
|
||
| <Card title="Agent configuration" icon="settings" href="/adk/setup/configuration"> | ||
| Project structure, models, state, and dependencies. | ||
| </Card> | ||
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
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.