AWS bedrock-agentcore documentation change
Summary
Restructured documentation formatting by adding example headings, renumbering steps, and adjusting whitespace for better readability in the AgentCore CLI get-started guide.
Security assessment
The changes are purely cosmetic and organizational, involving formatting adjustments, adding example headings, and renumbering steps. There is no mention of security vulnerabilities, patches, or security features. The changes do not introduce, modify, or remove any security-related content such as authentication, authorization, encryption, or compliance information.
Diff
diff --git a/bedrock-agentcore/latest/devguide/agentcore-get-started-cli.md b/bedrock-agentcore/latest/devguide/agentcore-get-started-cli.md index 395b4a2d5..9e6aeca30 100644 --- a//bedrock-agentcore/latest/devguide/agentcore-get-started-cli.md +++ b//bedrock-agentcore/latest/devguide/agentcore-get-started-cli.md @@ -57 +57 @@ Create a new project using the `create` command. You can use command-line flags -AgentCore CLI +###### Example @@ -58,0 +59 @@ AgentCore CLI +AgentCore CLI @@ -60 +60,0 @@ AgentCore CLI -Use the `--defaults` flag to generate a Python agent using the Strands Agents SDK with Amazon Bedrock as the model provider: @@ -61,0 +62 @@ Use the `--defaults` flag to generate a Python agent using the Strands Agents SD + 1. Use the `--defaults` flag to generate a Python agent using the Strands Agents SDK with Amazon Bedrock as the model provider: @@ -65 +65,0 @@ Use the `--defaults` flag to generate a Python agent using the Strands Agents SD -Interactive @@ -68 +67,0 @@ Interactive -Run `agentcore create` without flags to launch the interactive wizard: @@ -69,0 +69,4 @@ Run `agentcore create` without flags to launch the interactive wizard: +Interactive + + + 1. Run `agentcore create` without flags to launch the interactive wizard: @@ -73 +76 @@ Run `agentcore create` without flags to launch the interactive wizard: - 1. Enter your project name: + 2. Enter your project name: @@ -77 +80 @@ Run `agentcore create` without flags to launch the interactive wizard: - 2. Choose your agent framework and model provider: + 3. Choose your agent framework and model provider: @@ -81 +84 @@ Run `agentcore create` without flags to launch the interactive wizard: - 3. Review your configuration and confirm: + 4. Review your configuration and confirm: @@ -163 +166 @@ Before deploying, test your agent locally using the development server. Change i -AgentCore CLI +###### Example @@ -164,0 +168 @@ AgentCore CLI +AgentCore CLI @@ -167 +171 @@ AgentCore CLI - cd MyAgent + 1. cd MyAgent @@ -170 +173,0 @@ AgentCore CLI -Interactive @@ -173 +176,2 @@ Interactive -Run `agentcore` to open the TUI home screen, then select **dev** to start the local development server with an inline chat prompt: + +Interactive @@ -175,0 +180,2 @@ Run `agentcore` to open the TUI home screen, then select **dev** to start the lo + 1. Run `agentcore` to open the TUI home screen, then select **dev** to start the local development server with an inline chat prompt: + @@ -191 +200 @@ In a separate terminal, invoke your local agent: -AgentCore CLI +###### Example @@ -192,0 +202 @@ AgentCore CLI +AgentCore CLI @@ -195 +205 @@ AgentCore CLI - agentcore dev "Hello, what can you do?" + 1. agentcore dev "Hello, what can you do?" @@ -202 +210,0 @@ You can also stream the response in real time: -Interactive @@ -205 +212,0 @@ Interactive -Run `agentcore dev` without a prompt to open the interactive chat TUI, which streams responses by default and maintains your session automatically: @@ -206,0 +214,4 @@ Run `agentcore dev` without a prompt to open the interactive chat TUI, which str +Interactive + + + 1. Run `agentcore dev` without a prompt to open the interactive chat TUI, which streams responses by default and maintains your session automatically: @@ -219,0 +234,2 @@ When you are ready, deploy your agent to Amazon Bedrock AgentCore Runtime: +###### Example + @@ -222,0 +239,3 @@ AgentCore CLI + 1. agentcore deploy + + @@ -224 +242,0 @@ AgentCore CLI - agentcore deploy @@ -229 +247 @@ Interactive -From the AgentCore CLI home screen, select `deploy` to launch the interactive deployment flow: + 1. From the AgentCore CLI home screen, select `deploy` to launch the interactive deployment flow: @@ -254,0 +276,2 @@ After deployment completes, check the status of your resources: +###### Example + @@ -257,0 +281 @@ AgentCore CLI + 1. agentcore status @@ -259 +282,0 @@ AgentCore CLI - agentcore status @@ -261 +283,0 @@ AgentCore CLI -Interactive @@ -264 +286 @@ Interactive -Run `agentcore` and select **status** to view a live dashboard of all deployed resources: +Interactive @@ -266,0 +289,2 @@ Run `agentcore` and select **status** to view a live dashboard of all deployed r + 1. Run `agentcore` and select **status** to view a live dashboard of all deployed resources: + @@ -275 +302 @@ After deployment, invoke your agent with a prompt: -AgentCore CLI +###### Example @@ -276,0 +304 @@ AgentCore CLI +AgentCore CLI @@ -279 +307 @@ AgentCore CLI - agentcore invoke --runtime MyAgent "Hello, what can you do?" + 1. agentcore invoke --runtime MyAgent "Hello, what can you do?" @@ -299 +325,0 @@ To start a new session, run the invoke command without specifying a `--session-i -Interactive @@ -302 +327,0 @@ Interactive -Run `agentcore invoke` without a prompt to open the interactive chat TUI, which streams responses by default and maintains your session automatically: @@ -303,0 +329,4 @@ Run `agentcore invoke` without a prompt to open the interactive chat TUI, which +Interactive + + + 1. Run `agentcore invoke` without a prompt to open the interactive chat TUI, which streams responses by default and maintains your session automatically: @@ -321 +353 @@ Add a memory store with one or more strategies: -AgentCore CLI +###### Example @@ -322,0 +355 @@ AgentCore CLI +AgentCore CLI @@ -325 +358 @@ AgentCore CLI - agentcore add memory \ + 1. agentcore add memory \ @@ -332 +368 @@ Interactive -Run `agentcore add` and select **Memory** to launch the wizard: + 1. Run `agentcore add` and select **Memory** to launch the wizard: @@ -334 +370 @@ Run `agentcore add` and select **Memory** to launch the wizard: - 1. Enter a name for the memory store: + 2. Enter a name for the memory store: @@ -338 +374 @@ Run `agentcore add` and select **Memory** to launch the wizard: - 2. Select memory strategies: + 3. Select memory strategies: @@ -346,0 +383,2 @@ After adding memory, deploy to provision it: +###### Example + @@ -349,0 +388,3 @@ AgentCore CLI + 1. agentcore deploy + + @@ -351 +391,0 @@ AgentCore CLI - agentcore deploy @@ -356 +396 @@ Interactive -From the AgentCore CLI home screen, select `deploy` to launch the interactive deployment flow: + 1. From the AgentCore CLI home screen, select `deploy` to launch the interactive deployment flow: @@ -364 +407 @@ Available memory strategies are `SEMANTIC`, `SUMMARIZATION`, and `USER_PREFERENC -The AgentCore CLI supports multiple agents in a single project. Each agent gets its own code directory under `app/` and shares the project's deployment infrastructure. +The AgentCore CLI supports multiple agents in a single project. Each agent gets its own code directory under `app/` and shares the project’s deployment infrastructure. @@ -368 +411 @@ Add a second agent to the same project: -AgentCore CLI +###### Example @@ -369,0 +413 @@ AgentCore CLI +AgentCore CLI @@ -372 +416 @@ AgentCore CLI - agentcore add agent \ + 1. agentcore add agent \ @@ -394 +440 @@ Interactive -Run `agentcore add` and select **Agent** to launch the wizard: + 1. Run `agentcore add` and select **Agent** to launch the wizard: @@ -396 +442 @@ Run `agentcore add` and select **Agent** to launch the wizard: - 1. Choose the agent type and framework: + 2. Choose the agent type and framework: @@ -400 +446 @@ Run `agentcore add` and select **Agent** to launch the wizard: - 2. Select the framework and model provider: + 3. Select the framework and model provider: @@ -404 +450 @@ Run `agentcore add` and select **Agent** to launch the wizard: - 3. Review the configuration and confirm: + 4. Review the configuration and confirm: @@ -419 +465 @@ When you add an agent with a non-Bedrock model provider using `agentcore add age -AgentCore CLI +###### Example @@ -420,0 +467 @@ AgentCore CLI +AgentCore CLI @@ -423 +470 @@ AgentCore CLI - # API key credential + 1. # API key credential @@ -437 +487 @@ Interactive -Run `agentcore add` and select **Identity** to launch the wizard: + 1. Run `agentcore add` and select **Identity** to launch the wizard: @@ -439 +489 @@ Run `agentcore add` and select **Identity** to launch the wizard: - 1. Choose the credential type (API Key or OAuth): + 2. Choose the credential type (API Key or OAuth): @@ -443 +493 @@ Run `agentcore add` and select **Identity** to launch the wizard: - 2. Enter the credential name and value, then confirm. + 3. Enter the credential name and value, then confirm. @@ -475 +525 @@ To tear down all AWS resources created by the CLI, first remove all resources fr -AgentCore CLI +###### Example @@ -476,0 +527 @@ AgentCore CLI +AgentCore CLI @@ -479 +530 @@ AgentCore CLI - agentcore remove all + 1. agentcore remove all @@ -487 +536,0 @@ To preview what will be removed before taking action: -Interactive @@ -490 +538,0 @@ Interactive -Run `agentcore` and select **remove** to interactively choose which resources to remove: @@ -491,0 +540,4 @@ Run `agentcore` and select **remove** to interactively choose which resources to +Interactive + + + 1. Run `agentcore` and select **remove** to interactively choose which resources to remove: