Skip to content

chore: improve documentation#232

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

Merged
aidandaly24 merged 2 commits into from
Feb 10, 2026
Merged

chore: improve documentation #232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef1259d
chore: improve documentation
tejaskash Feb 10, 2026
2be673e
fix: update snapshots for ONBOARDING.md and SCHEMA.md changes
tejaskash Feb 10, 2026
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
20 changes: 18 additions & 2 deletions AGENTS.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,10 +23,26 @@ Note: CDK L3 constructs are in a separate package `@aws/agentcore-l3-cdk-constru
## CLI Commands

- `create` - Create new AgentCore project
- `add` - Add resources (agent, memory, identity, target)
- `remove` - Remove resources (agent, memory, identity, target, all)
- `deploy` - Deploy infrastructure to AWS
- `dev` - Local development server
- `invoke` - Invoke deployed agents
- `destroy` - Tear down deployed resources
- `status` - Check deployment status
- `dev` - Local development server
- `invoke` - Invoke agents (local or deployed)
- `package` - Package agent artifacts without deploying
- `validate` - Validate configuration files
- `update` - Check for CLI updates
- `help` - Display help information

### Agent Types

- **Template agents**: Created from framework templates (Strands, LangChain_LangGraph, GoogleADK, OpenAIAgents)
- **BYO agents**: Bring your own code with `agentcore add agent --type byo`

### Coming Soon

- MCP gateway and tool support (`add gateway`, `add mcp-tool`) - currently hidden

## Vended CDK Project

Expand Down
83 changes: 25 additions & 58 deletions docs/commands.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,21 +30,21 @@ agentcore create --name MyProject --no-agent
agentcore create --name MyProject --defaults --dry-run
```

| Flag | Description |
| ---------------------- | ------------------------------------------------------------------------ |
| `--name <name>` | Project name (alphanumeric, max 23 chars) |
| `--defaults` | Use defaults (Python, Strands, Bedrock, no memory) |
| `--no-agent` | Skip agent creation |
| `--language <lang>` | `Python` or `TypeScript` |
| `--framework <fw>` | `Strands`, `LangChain_LangGraph`, `AutoGen`, `GoogleADK`, `OpenAIAgents` |
| `--model-provider <p>` | `Bedrock`, `Anthropic`, `OpenAI`, `Gemini` |
| `--api-key <key>` | API key for non-Bedrock providers |
| `--memory <opt>` | `none`, `shortTerm`, `longAndShortTerm` |
| `--output-dir <dir>` | Output directory |
| `--skip-git` | Skip git initialization |
| `--skip-python-setup` | Skip venv setup |
| `--dry-run` | Preview without creating |
| `--json` | JSON output |
| Flag | Description |
| ---------------------- | ------------------------------------------------------------- |
| `--name <name>` | Project name (alphanumeric, max 23 chars) |
| `--defaults` | Use defaults (Python, Strands, Bedrock, no memory) |
| `--no-agent` | Skip agent creation |
| `--language <lang>` | `Python` or `TypeScript` |
| `--framework <fw>` | `Strands`, `LangChain_LangGraph`, `GoogleADK`, `OpenAIAgents` |
| `--model-provider <p>` | `Bedrock`, `Anthropic`, `OpenAI`, `Gemini` |
| `--api-key <key>` | API key for non-Bedrock providers |
| `--memory <opt>` | `none`, `shortTerm`, `longAndShortTerm` |
| `--output-dir <dir>` | Output directory |
| `--skip-git` | Skip git initialization |
| `--skip-python-setup` | Skip venv setup |
| `--dry-run` | Preview without creating |
| `--json` | JSON output |

### deploy

Expand DownExpand Up@@ -151,15 +151,13 @@ agentcore add agent \

### add memory

Add a memory resource.
Add a memory resource. Memory is a top-level resource in the flat resource model.

```bash
agentcore add memory \
--name SharedMemory \
--strategies SEMANTIC,SUMMARIZATION \
--expiry 30 \
--owner MyAgent \
--users AgentA,AgentB
--expiry 30
```

| Flag | Description |
Expand All@@ -168,30 +166,23 @@ agentcore add memory \
| `--description <desc>` | Description |
| `--strategies <types>` | Comma-separated: `SEMANTIC`, `SUMMARIZATION`, `USER_PREFERENCE`, `CUSTOM` |
| `--expiry <days>` | Event expiry (default: 30) |
| `--owner <agent>` | Owning agent |
| `--users <agents>` | Comma-separated users |
| `--json` | JSON output |

### add identity

Add an identity provider (API key).
Add a credential provider (API key). Credentials are top-level resources in the flat resource model.

```bash
agentcore add identity \
--name OpenAI \
--type ApiKeyCredentialProvider \
--api-key sk-... \
--owner MyAgent
--api-key sk-...
```

| Flag | Description |
| ------------------ | -------------------------- |
| `--name <name>` | Identity name |
| `--type <type>` | `ApiKeyCredentialProvider` |
| `--api-key <key>` | API key value |
| `--owner <agent>` | Owning agent |
| `--users <agents>` | Comma-separated users |
| `--json` | JSON output |
| Flag | Description |
| ----------------- | --------------- |
| `--name <name>` | Credential name |
| `--api-key <key>` | API key value |
| `--json` | JSON output |

### add target

Expand All@@ -213,21 +204,6 @@ agentcore add target \
| `--description <desc>` | Description |
| `--json` | JSON output |

### add bind

Connect resources to agents.

```bash
# Agent-to-agent
agentcore add bind agent --source CallerAgent --target HelperAgent

# Memory
agentcore add bind memory --agent MyAgent --memory SharedMemory --access read

# Identity
agentcore add bind identity --agent MyAgent --identity OpenAI
```

### remove

Remove resources from project.
Expand DownExpand Up@@ -315,15 +291,6 @@ agentcore package -d ./my-project
| `-d, --directory <path>` | Project directory |
| `-a, --agent <name>` | Package specific agent |

### outline

Display project resource tree.

```bash
agentcore outline
agentcore outline agent MyAgent
```

### update

Check for CLI updates.
Expand DownExpand Up@@ -354,7 +321,7 @@ agentcore deploy --target production -y --json
```bash
agentcore create --name MyProject --defaults
cd MyProject
agentcore add memory --name SharedMemory --strategies SEMANTIC --owner MyProject
agentcore add memory --name SharedMemory --strategies SEMANTIC
agentcore add target --name dev --account 123456789012 --region us-west-2
agentcore deploy --target dev -y
```
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
chore: improve documentation by tejaskash · Pull Request #232 · aws/agentcore-cli · GitHub
Skip to content
chore: improve documentation#232

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

 Merged

aidandaly24
merged 2 commits into

from

Feb 10, 2026
 Merged


chore: improve documentation
#232
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
ef1259d

chore: improve documentation


tejaskash Feb 10, 2026
2be673e

fix: update snapshots for ONBOARDING.md and SCHEMA.md changes


tejaskash Feb 10, 2026

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


20 changes: 18 additions & 2 deletions
AGENTS.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,10 +23,26 @@ Note: CDK L3 constructs are in a separate package `@aws/agentcore-l3-cdk-constru
## CLI Commands

- `create` - Create new AgentCore project
- `add` - Add resources (agent, memory, identity, target)
- `remove` - Remove resources (agent, memory, identity, target, all)
- `deploy` - Deploy infrastructure to AWS
- `dev` - Local development server
- `invoke` - Invoke deployed agents
- `destroy` - Tear down deployed resources
- `status` - Check deployment status
- `dev` - Local development server
- `invoke` - Invoke agents (local or deployed)
- `package` - Package agent artifacts without deploying
- `validate` - Validate configuration files
- `update` - Check for CLI updates
- `help` - Display help information

### Agent Types

- **Template agents**: Created from framework templates (Strands, LangChain_LangGraph, GoogleADK, OpenAIAgents)
- **BYO agents**: Bring your own code with `agentcore add agent --type byo`

### Coming Soon

- MCP gateway and tool support (`add gateway`, `add mcp-tool`) - currently hidden

## Vended CDK Project

Expand Down

83 changes: 25 additions & 58 deletions
docs/commands.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,21 +30,21 @@ agentcore create --name MyProject --no-agent
agentcore create --name MyProject --defaults --dry-run
```

| Flag | Description |
| ---------------------- | ------------------------------------------------------------------------ |
| `--name <name>` | Project name (alphanumeric, max 23 chars) |
| `--defaults` | Use defaults (Python, Strands, Bedrock, no memory) |
| `--no-agent` | Skip agent creation |
| `--language <lang>` | `Python` or `TypeScript` |
| `--framework <fw>` | `Strands`, `LangChain_LangGraph`, `AutoGen`, `GoogleADK`, `OpenAIAgents` |
| `--model-provider <p>` | `Bedrock`, `Anthropic`, `OpenAI`, `Gemini` |
| `--api-key <key>` | API key for non-Bedrock providers |
| `--memory <opt>` | `none`, `shortTerm`, `longAndShortTerm` |
| `--output-dir <dir>` | Output directory |
| `--skip-git` | Skip git initialization |
| `--skip-python-setup` | Skip venv setup |
| `--dry-run` | Preview without creating |
| `--json` | JSON output |
| Flag | Description |
| ---------------------- | ------------------------------------------------------------- |
| `--name <name>` | Project name (alphanumeric, max 23 chars) |
| `--defaults` | Use defaults (Python, Strands, Bedrock, no memory) |
| `--no-agent` | Skip agent creation |
| `--language <lang>` | `Python` or `TypeScript` |
| `--framework <fw>` | `Strands`, `LangChain_LangGraph`, `GoogleADK`, `OpenAIAgents` |
| `--model-provider <p>` | `Bedrock`, `Anthropic`, `OpenAI`, `Gemini` |
| `--api-key <key>` | API key for non-Bedrock providers |
| `--memory <opt>` | `none`, `shortTerm`, `longAndShortTerm` |
| `--output-dir <dir>` | Output directory |
| `--skip-git` | Skip git initialization |
| `--skip-python-setup` | Skip venv setup |
| `--dry-run` | Preview without creating |
| `--json` | JSON output |

### deploy

Expand DownExpand Up@@ -151,15 +151,13 @@ agentcore add agent \

### add memory

Add a memory resource.
Add a memory resource. Memory is a top-level resource in the flat resource model.

```bash
agentcore add memory \
 --name SharedMemory \
 --strategies SEMANTIC,SUMMARIZATION \
 --expiry 30 \
 --owner MyAgent \
 --users AgentA,AgentB
 --expiry 30
```

| Flag | Description |
Expand All@@ -168,30 +166,23 @@ agentcore add memory \
| `--description <desc>` | Description |
| `--strategies <types>` | Comma-separated: `SEMANTIC`, `SUMMARIZATION`, `USER_PREFERENCE`, `CUSTOM` |
| `--expiry <days>` | Event expiry (default: 30) |
| `--owner <agent>` | Owning agent |
| `--users <agents>` | Comma-separated users |
| `--json` | JSON output |

### add identity

Add an identity provider (API key).
Add a credential provider (API key). Credentials are top-level resources in the flat resource model.

```bash
agentcore add identity \
 --name OpenAI \
 --type ApiKeyCredentialProvider \
 --api-key sk-... \
 --owner MyAgent
 --api-key sk-...
```

| Flag | Description |
| ------------------ | -------------------------- |
| `--name <name>` | Identity name |
| `--type <type>` | `ApiKeyCredentialProvider` |
| `--api-key <key>` | API key value |
| `--owner <agent>` | Owning agent |
| `--users <agents>` | Comma-separated users |
| `--json` | JSON output |
| Flag | Description |
| ----------------- | --------------- |
| `--name <name>` | Credential name |
| `--api-key <key>` | API key value |
| `--json` | JSON output |

### add target

Expand All@@ -213,21 +204,6 @@ agentcore add target \
| `--description <desc>` | Description |
| `--json` | JSON output |

### add bind

Connect resources to agents.

```bash
# Agent-to-agent
agentcore add bind agent --source CallerAgent --target HelperAgent

# Memory
agentcore add bind memory --agent MyAgent --memory SharedMemory --access read

# Identity
agentcore add bind identity --agent MyAgent --identity OpenAI
```

### remove

Remove resources from project.
Expand DownExpand Up@@ -315,15 +291,6 @@ agentcore package -d ./my-project
| `-d, --directory <path>` | Project directory |
| `-a, --agent <name>` | Package specific agent |

### outline

Display project resource tree.

```bash
agentcore outline
agentcore outline agent MyAgent
```

### update

Check for CLI updates.
Expand DownExpand Up@@ -354,7 +321,7 @@ agentcore deploy --target production -y --json
```bash
agentcore create --name MyProject --defaults
cd MyProject
agentcore add memory --name SharedMemory --strategies SEMANTIC --owner MyProject
agentcore add memory --name SharedMemory --strategies SEMANTIC
agentcore add target --name dev --account 123456789012 --region us-west-2
agentcore deploy --target dev -y
```
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
chore: improve documentation by tejaskash · Pull Request #232 · aws/agentcore-cli · GitHub
Skip to content
chore: improve documentation#232

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

 Merged

aidandaly24
merged 2 commits into

from

Feb 10, 2026
 Merged


chore: improve documentation
#232
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
ef1259d

chore: improve documentation


tejaskash Feb 10, 2026
2be673e

fix: update snapshots for ONBOARDING.md and SCHEMA.md changes


tejaskash Feb 10, 2026

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


20 changes: 18 additions & 2 deletions
AGENTS.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,10 +23,26 @@ Note: CDK L3 constructs are in a separate package `@aws/agentcore-l3-cdk-constru
## CLI Commands

- `create` - Create new AgentCore project
- `add` - Add resources (agent, memory, identity, target)
- `remove` - Remove resources (agent, memory, identity, target, all)
- `deploy` - Deploy infrastructure to AWS
- `dev` - Local development server
- `invoke` - Invoke deployed agents
- `destroy` - Tear down deployed resources
- `status` - Check deployment status
- `dev` - Local development server
- `invoke` - Invoke agents (local or deployed)
- `package` - Package agent artifacts without deploying
- `validate` - Validate configuration files
- `update` - Check for CLI updates
- `help` - Display help information

### Agent Types

- **Template agents**: Created from framework templates (Strands, LangChain_LangGraph, GoogleADK, OpenAIAgents)
- **BYO agents**: Bring your own code with `agentcore add agent --type byo`

### Coming Soon

- MCP gateway and tool support (`add gateway`, `add mcp-tool`) - currently hidden

## Vended CDK Project

Expand Down

83 changes: 25 additions & 58 deletions
docs/commands.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,21 +30,21 @@ agentcore create --name MyProject --no-agent
agentcore create --name MyProject --defaults --dry-run
```

| Flag | Description |
| ---------------------- | ------------------------------------------------------------------------ |
| `--name <name>` | Project name (alphanumeric, max 23 chars) |
| `--defaults` | Use defaults (Python, Strands, Bedrock, no memory) |
| `--no-agent` | Skip agent creation |
| `--language <lang>` | `Python` or `TypeScript` |
| `--framework <fw>` | `Strands`, `LangChain_LangGraph`, `AutoGen`, `GoogleADK`, `OpenAIAgents` |
| `--model-provider <p>` | `Bedrock`, `Anthropic`, `OpenAI`, `Gemini` |
| `--api-key <key>` | API key for non-Bedrock providers |
| `--memory <opt>` | `none`, `shortTerm`, `longAndShortTerm` |
| `--output-dir <dir>` | Output directory |
| `--skip-git` | Skip git initialization |
| `--skip-python-setup` | Skip venv setup |
| `--dry-run` | Preview without creating |
| `--json` | JSON output |
| Flag | Description |
| ---------------------- | ------------------------------------------------------------- |
| `--name <name>` | Project name (alphanumeric, max 23 chars) |
| `--defaults` | Use defaults (Python, Strands, Bedrock, no memory) |
| `--no-agent` | Skip agent creation |
| `--language <lang>` | `Python` or `TypeScript` |
| `--framework <fw>` | `Strands`, `LangChain_LangGraph`, `GoogleADK`, `OpenAIAgents` |
| `--model-provider <p>` | `Bedrock`, `Anthropic`, `OpenAI`, `Gemini` |
| `--api-key <key>` | API key for non-Bedrock providers |
| `--memory <opt>` | `none`, `shortTerm`, `longAndShortTerm` |
| `--output-dir <dir>` | Output directory |
| `--skip-git` | Skip git initialization |
| `--skip-python-setup` | Skip venv setup |
| `--dry-run` | Preview without creating |
| `--json` | JSON output |

### deploy

Expand DownExpand Up@@ -151,15 +151,13 @@ agentcore add agent \

### add memory

Add a memory resource.
Add a memory resource. Memory is a top-level resource in the flat resource model.

```bash
agentcore add memory \
 --name SharedMemory \
 --strategies SEMANTIC,SUMMARIZATION \
 --expiry 30 \
 --owner MyAgent \
 --users AgentA,AgentB
 --expiry 30
```

| Flag | Description |
Expand All@@ -168,30 +166,23 @@ agentcore add memory \
| `--description <desc>` | Description |
| `--strategies <types>` | Comma-separated: `SEMANTIC`, `SUMMARIZATION`, `USER_PREFERENCE`, `CUSTOM` |
| `--expiry <days>` | Event expiry (default: 30) |
| `--owner <agent>` | Owning agent |
| `--users <agents>` | Comma-separated users |
| `--json` | JSON output |

### add identity

Add an identity provider (API key).
Add a credential provider (API key). Credentials are top-level resources in the flat resource model.

```bash
agentcore add identity \
 --name OpenAI \
 --type ApiKeyCredentialProvider \
 --api-key sk-... \
 --owner MyAgent
 --api-key sk-...
```

| Flag | Description |
| ------------------ | -------------------------- |
| `--name <name>` | Identity name |
| `--type <type>` | `ApiKeyCredentialProvider` |
| `--api-key <key>` | API key value |
| `--owner <agent>` | Owning agent |
| `--users <agents>` | Comma-separated users |
| `--json` | JSON output |
| Flag | Description |
| ----------------- | --------------- |
| `--name <name>` | Credential name |
| `--api-key <key>` | API key value |
| `--json` | JSON output |

### add target

Expand All@@ -213,21 +204,6 @@ agentcore add target \
| `--description <desc>` | Description |
| `--json` | JSON output |

### add bind

Connect resources to agents.

```bash
# Agent-to-agent
agentcore add bind agent --source CallerAgent --target HelperAgent

# Memory
agentcore add bind memory --agent MyAgent --memory SharedMemory --access read

# Identity
agentcore add bind identity --agent MyAgent --identity OpenAI
```

### remove

Remove resources from project.
Expand DownExpand Up@@ -315,15 +291,6 @@ agentcore package -d ./my-project
| `-d, --directory <path>` | Project directory |
| `-a, --agent <name>` | Package specific agent |

### outline

Display project resource tree.

```bash
agentcore outline
agentcore outline agent MyAgent
```

### update

Check for CLI updates.
Expand DownExpand Up@@ -354,7 +321,7 @@ agentcore deploy --target production -y --json
```bash
agentcore create --name MyProject --defaults
cd MyProject
agentcore add memory --name SharedMemory --strategies SEMANTIC --owner MyProject
agentcore add memory --name SharedMemory --strategies SEMANTIC
agentcore add target --name dev --account 123456789012 --region us-west-2
agentcore deploy --target dev -y
```
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
chore: improve documentation by tejaskash · Pull Request #232 · aws/agentcore-cli · GitHub
Skip to content
chore: improve documentation#232

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

 Merged

aidandaly24
merged 2 commits into

from

Feb 10, 2026
 Merged


chore: improve documentation
#232
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
ef1259d

chore: improve documentation


tejaskash Feb 10, 2026
2be673e

fix: update snapshots for ONBOARDING.md and SCHEMA.md changes


tejaskash Feb 10, 2026

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


20 changes: 18 additions & 2 deletions
AGENTS.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,10 +23,26 @@ Note: CDK L3 constructs are in a separate package `@aws/agentcore-l3-cdk-constru
## CLI Commands

- `create` - Create new AgentCore project
- `add` - Add resources (agent, memory, identity, target)
- `remove` - Remove resources (agent, memory, identity, target, all)
- `deploy` - Deploy infrastructure to AWS
- `dev` - Local development server
- `invoke` - Invoke deployed agents
- `destroy` - Tear down deployed resources
- `status` - Check deployment status
- `dev` - Local development server
- `invoke` - Invoke agents (local or deployed)
- `package` - Package agent artifacts without deploying
- `validate` - Validate configuration files
- `update` - Check for CLI updates
- `help` - Display help information

### Agent Types

- **Template agents**: Created from framework templates (Strands, LangChain_LangGraph, GoogleADK, OpenAIAgents)
- **BYO agents**: Bring your own code with `agentcore add agent --type byo`

### Coming Soon

- MCP gateway and tool support (`add gateway`, `add mcp-tool`) - currently hidden

## Vended CDK Project

Expand Down

83 changes: 25 additions & 58 deletions
docs/commands.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,21 +30,21 @@ agentcore create --name MyProject --no-agent
agentcore create --name MyProject --defaults --dry-run
```

| Flag | Description |
| ---------------------- | ------------------------------------------------------------------------ |
| `--name <name>` | Project name (alphanumeric, max 23 chars) |
| `--defaults` | Use defaults (Python, Strands, Bedrock, no memory) |
| `--no-agent` | Skip agent creation |
| `--language <lang>` | `Python` or `TypeScript` |
| `--framework <fw>` | `Strands`, `LangChain_LangGraph`, `AutoGen`, `GoogleADK`, `OpenAIAgents` |
| `--model-provider <p>` | `Bedrock`, `Anthropic`, `OpenAI`, `Gemini` |
| `--api-key <key>` | API key for non-Bedrock providers |
| `--memory <opt>` | `none`, `shortTerm`, `longAndShortTerm` |
| `--output-dir <dir>` | Output directory |
| `--skip-git` | Skip git initialization |
| `--skip-python-setup` | Skip venv setup |
| `--dry-run` | Preview without creating |
| `--json` | JSON output |
| Flag | Description |
| ---------------------- | ------------------------------------------------------------- |
| `--name <name>` | Project name (alphanumeric, max 23 chars) |
| `--defaults` | Use defaults (Python, Strands, Bedrock, no memory) |
| `--no-agent` | Skip agent creation |
| `--language <lang>` | `Python` or `TypeScript` |
| `--framework <fw>` | `Strands`, `LangChain_LangGraph`, `GoogleADK`, `OpenAIAgents` |
| `--model-provider <p>` | `Bedrock`, `Anthropic`, `OpenAI`, `Gemini` |
| `--api-key <key>` | API key for non-Bedrock providers |
| `--memory <opt>` | `none`, `shortTerm`, `longAndShortTerm` |
| `--output-dir <dir>` | Output directory |
| `--skip-git` | Skip git initialization |
| `--skip-python-setup` | Skip venv setup |
| `--dry-run` | Preview without creating |
| `--json` | JSON output |

### deploy

Expand DownExpand Up@@ -151,15 +151,13 @@ agentcore add agent \

### add memory

Add a memory resource.
Add a memory resource. Memory is a top-level resource in the flat resource model.

```bash
agentcore add memory \
 --name SharedMemory \
 --strategies SEMANTIC,SUMMARIZATION \
 --expiry 30 \
 --owner MyAgent \
 --users AgentA,AgentB
 --expiry 30
```

| Flag | Description |
Expand All@@ -168,30 +166,23 @@ agentcore add memory \
| `--description <desc>` | Description |
| `--strategies <types>` | Comma-separated: `SEMANTIC`, `SUMMARIZATION`, `USER_PREFERENCE`, `CUSTOM` |
| `--expiry <days>` | Event expiry (default: 30) |
| `--owner <agent>` | Owning agent |
| `--users <agents>` | Comma-separated users |
| `--json` | JSON output |

### add identity

Add an identity provider (API key).
Add a credential provider (API key). Credentials are top-level resources in the flat resource model.

```bash
agentcore add identity \
 --name OpenAI \
 --type ApiKeyCredentialProvider \
 --api-key sk-... \
 --owner MyAgent
 --api-key sk-...
```

| Flag | Description |
| ------------------ | -------------------------- |
| `--name <name>` | Identity name |
| `--type <type>` | `ApiKeyCredentialProvider` |
| `--api-key <key>` | API key value |
| `--owner <agent>` | Owning agent |
| `--users <agents>` | Comma-separated users |
| `--json` | JSON output |
| Flag | Description |
| ----------------- | --------------- |
| `--name <name>` | Credential name |
| `--api-key <key>` | API key value |
| `--json` | JSON output |

### add target

Expand All@@ -213,21 +204,6 @@ agentcore add target \
| `--description <desc>` | Description |
| `--json` | JSON output |

### add bind

Connect resources to agents.

```bash
# Agent-to-agent
agentcore add bind agent --source CallerAgent --target HelperAgent

# Memory
agentcore add bind memory --agent MyAgent --memory SharedMemory --access read

# Identity
agentcore add bind identity --agent MyAgent --identity OpenAI
```

### remove

Remove resources from project.
Expand DownExpand Up@@ -315,15 +291,6 @@ agentcore package -d ./my-project
| `-d, --directory <path>` | Project directory |
| `-a, --agent <name>` | Package specific agent |

### outline

Display project resource tree.

```bash
agentcore outline
agentcore outline agent MyAgent
```

### update

Check for CLI updates.
Expand DownExpand Up@@ -354,7 +321,7 @@ agentcore deploy --target production -y --json
```bash
agentcore create --name MyProject --defaults
cd MyProject
agentcore add memory --name SharedMemory --strategies SEMANTIC --owner MyProject
agentcore add memory --name SharedMemory --strategies SEMANTIC
agentcore add target --name dev --account 123456789012 --region us-west-2
agentcore deploy --target dev -y
```
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
chore: improve documentation by tejaskash · Pull Request #232 · aws/agentcore-cli · GitHub
Skip to content
chore: improve documentation#232

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

 Merged

aidandaly24
merged 2 commits into

from

Feb 10, 2026
 Merged


chore: improve documentation
#232
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
ef1259d

chore: improve documentation


tejaskash Feb 10, 2026
2be673e

fix: update snapshots for ONBOARDING.md and SCHEMA.md changes


tejaskash Feb 10, 2026

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


20 changes: 18 additions & 2 deletions
AGENTS.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,10 +23,26 @@ Note: CDK L3 constructs are in a separate package `@aws/agentcore-l3-cdk-constru
## CLI Commands

- `create` - Create new AgentCore project
- `add` - Add resources (agent, memory, identity, target)
- `remove` - Remove resources (agent, memory, identity, target, all)
- `deploy` - Deploy infrastructure to AWS
- `dev` - Local development server
- `invoke` - Invoke deployed agents
- `destroy` - Tear down deployed resources
- `status` - Check deployment status
- `dev` - Local development server
- `invoke` - Invoke agents (local or deployed)
- `package` - Package agent artifacts without deploying
- `validate` - Validate configuration files
- `update` - Check for CLI updates
- `help` - Display help information

### Agent Types

- **Template agents**: Created from framework templates (Strands, LangChain_LangGraph, GoogleADK, OpenAIAgents)
- **BYO agents**: Bring your own code with `agentcore add agent --type byo`

### Coming Soon

- MCP gateway and tool support (`add gateway`, `add mcp-tool`) - currently hidden

## Vended CDK Project

Expand Down

83 changes: 25 additions & 58 deletions
docs/commands.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,21 +30,21 @@ agentcore create --name MyProject --no-agent
agentcore create --name MyProject --defaults --dry-run
```

| Flag | Description |
| ---------------------- | ------------------------------------------------------------------------ |
| `--name <name>` | Project name (alphanumeric, max 23 chars) |
| `--defaults` | Use defaults (Python, Strands, Bedrock, no memory) |
| `--no-agent` | Skip agent creation |
| `--language <lang>` | `Python` or `TypeScript` |
| `--framework <fw>` | `Strands`, `LangChain_LangGraph`, `AutoGen`, `GoogleADK`, `OpenAIAgents` |
| `--model-provider <p>` | `Bedrock`, `Anthropic`, `OpenAI`, `Gemini` |
| `--api-key <key>` | API key for non-Bedrock providers |
| `--memory <opt>` | `none`, `shortTerm`, `longAndShortTerm` |
| `--output-dir <dir>` | Output directory |
| `--skip-git` | Skip git initialization |
| `--skip-python-setup` | Skip venv setup |
| `--dry-run` | Preview without creating |
| `--json` | JSON output |
| Flag | Description |
| ---------------------- | ------------------------------------------------------------- |
| `--name <name>` | Project name (alphanumeric, max 23 chars) |
| `--defaults` | Use defaults (Python, Strands, Bedrock, no memory) |
| `--no-agent` | Skip agent creation |
| `--language <lang>` | `Python` or `TypeScript` |
| `--framework <fw>` | `Strands`, `LangChain_LangGraph`, `GoogleADK`, `OpenAIAgents` |
| `--model-provider <p>` | `Bedrock`, `Anthropic`, `OpenAI`, `Gemini` |
| `--api-key <key>` | API key for non-Bedrock providers |
| `--memory <opt>` | `none`, `shortTerm`, `longAndShortTerm` |
| `--output-dir <dir>` | Output directory |
| `--skip-git` | Skip git initialization |
| `--skip-python-setup` | Skip venv setup |
| `--dry-run` | Preview without creating |
| `--json` | JSON output |

### deploy

Expand DownExpand Up@@ -151,15 +151,13 @@ agentcore add agent \

### add memory

Add a memory resource.
Add a memory resource. Memory is a top-level resource in the flat resource model.

```bash
agentcore add memory \
 --name SharedMemory \
 --strategies SEMANTIC,SUMMARIZATION \
 --expiry 30 \
 --owner MyAgent \
 --users AgentA,AgentB
 --expiry 30
```

| Flag | Description |
Expand All@@ -168,30 +166,23 @@ agentcore add memory \
| `--description <desc>` | Description |
| `--strategies <types>` | Comma-separated: `SEMANTIC`, `SUMMARIZATION`, `USER_PREFERENCE`, `CUSTOM` |
| `--expiry <days>` | Event expiry (default: 30) |
| `--owner <agent>` | Owning agent |
| `--users <agents>` | Comma-separated users |
| `--json` | JSON output |

### add identity

Add an identity provider (API key).
Add a credential provider (API key). Credentials are top-level resources in the flat resource model.

```bash
agentcore add identity \
 --name OpenAI \
 --type ApiKeyCredentialProvider \
 --api-key sk-... \
 --owner MyAgent
 --api-key sk-...
```

| Flag | Description |
| ------------------ | -------------------------- |
| `--name <name>` | Identity name |
| `--type <type>` | `ApiKeyCredentialProvider` |
| `--api-key <key>` | API key value |
| `--owner <agent>` | Owning agent |
| `--users <agents>` | Comma-separated users |
| `--json` | JSON output |
| Flag | Description |
| ----------------- | --------------- |
| `--name <name>` | Credential name |
| `--api-key <key>` | API key value |
| `--json` | JSON output |

### add target

Expand All@@ -213,21 +204,6 @@ agentcore add target \
| `--description <desc>` | Description |
| `--json` | JSON output |

### add bind

Connect resources to agents.

```bash
# Agent-to-agent
agentcore add bind agent --source CallerAgent --target HelperAgent

# Memory
agentcore add bind memory --agent MyAgent --memory SharedMemory --access read

# Identity
agentcore add bind identity --agent MyAgent --identity OpenAI
```

### remove

Remove resources from project.
Expand DownExpand Up@@ -315,15 +291,6 @@ agentcore package -d ./my-project
| `-d, --directory <path>` | Project directory |
| `-a, --agent <name>` | Package specific agent |

### outline

Display project resource tree.

```bash
agentcore outline
agentcore outline agent MyAgent
```

### update

Check for CLI updates.
Expand DownExpand Up@@ -354,7 +321,7 @@ agentcore deploy --target production -y --json
```bash
agentcore create --name MyProject --defaults
cd MyProject
agentcore add memory --name SharedMemory --strategies SEMANTIC --owner MyProject
agentcore add memory --name SharedMemory --strategies SEMANTIC
agentcore add target --name dev --account 123456789012 --region us-west-2
agentcore deploy --target dev -y
```
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
chore: improve documentation by tejaskash · Pull Request #232 · aws/agentcore-cli · GitHub
Skip to content
chore: improve documentation#232

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

 Merged

aidandaly24
merged 2 commits into

from

Feb 10, 2026
 Merged


chore: improve documentation
#232
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
ef1259d

chore: improve documentation


tejaskash Feb 10, 2026
2be673e

fix: update snapshots for ONBOARDING.md and SCHEMA.md changes


tejaskash Feb 10, 2026

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


20 changes: 18 additions & 2 deletions
AGENTS.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,10 +23,26 @@ Note: CDK L3 constructs are in a separate package `@aws/agentcore-l3-cdk-constru
## CLI Commands

- `create` - Create new AgentCore project
- `add` - Add resources (agent, memory, identity, target)
- `remove` - Remove resources (agent, memory, identity, target, all)
- `deploy` - Deploy infrastructure to AWS
- `dev` - Local development server
- `invoke` - Invoke deployed agents
- `destroy` - Tear down deployed resources
- `status` - Check deployment status
- `dev` - Local development server
- `invoke` - Invoke agents (local or deployed)
- `package` - Package agent artifacts without deploying
- `validate` - Validate configuration files
- `update` - Check for CLI updates
- `help` - Display help information

### Agent Types

- **Template agents**: Created from framework templates (Strands, LangChain_LangGraph, GoogleADK, OpenAIAgents)
- **BYO agents**: Bring your own code with `agentcore add agent --type byo`

### Coming Soon

- MCP gateway and tool support (`add gateway`, `add mcp-tool`) - currently hidden

## Vended CDK Project

Expand Down

83 changes: 25 additions & 58 deletions
docs/commands.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,21 +30,21 @@ agentcore create --name MyProject --no-agent
agentcore create --name MyProject --defaults --dry-run
```

| Flag | Description |
| ---------------------- | ------------------------------------------------------------------------ |
| `--name <name>` | Project name (alphanumeric, max 23 chars) |
| `--defaults` | Use defaults (Python, Strands, Bedrock, no memory) |
| `--no-agent` | Skip agent creation |
| `--language <lang>` | `Python` or `TypeScript` |
| `--framework <fw>` | `Strands`, `LangChain_LangGraph`, `AutoGen`, `GoogleADK`, `OpenAIAgents` |
| `--model-provider <p>` | `Bedrock`, `Anthropic`, `OpenAI`, `Gemini` |
| `--api-key <key>` | API key for non-Bedrock providers |
| `--memory <opt>` | `none`, `shortTerm`, `longAndShortTerm` |
| `--output-dir <dir>` | Output directory |
| `--skip-git` | Skip git initialization |
| `--skip-python-setup` | Skip venv setup |
| `--dry-run` | Preview without creating |
| `--json` | JSON output |
| Flag | Description |
| ---------------------- | ------------------------------------------------------------- |
| `--name <name>` | Project name (alphanumeric, max 23 chars) |
| `--defaults` | Use defaults (Python, Strands, Bedrock, no memory) |
| `--no-agent` | Skip agent creation |
| `--language <lang>` | `Python` or `TypeScript` |
| `--framework <fw>` | `Strands`, `LangChain_LangGraph`, `GoogleADK`, `OpenAIAgents` |
| `--model-provider <p>` | `Bedrock`, `Anthropic`, `OpenAI`, `Gemini` |
| `--api-key <key>` | API key for non-Bedrock providers |
| `--memory <opt>` | `none`, `shortTerm`, `longAndShortTerm` |
| `--output-dir <dir>` | Output directory |
| `--skip-git` | Skip git initialization |
| `--skip-python-setup` | Skip venv setup |
| `--dry-run` | Preview without creating |
| `--json` | JSON output |

### deploy

Expand DownExpand Up@@ -151,15 +151,13 @@ agentcore add agent \

### add memory

Add a memory resource.
Add a memory resource. Memory is a top-level resource in the flat resource model.

```bash
agentcore add memory \
 --name SharedMemory \
 --strategies SEMANTIC,SUMMARIZATION \
 --expiry 30 \
 --owner MyAgent \
 --users AgentA,AgentB
 --expiry 30
```

| Flag | Description |
Expand All@@ -168,30 +166,23 @@ agentcore add memory \
| `--description <desc>` | Description |
| `--strategies <types>` | Comma-separated: `SEMANTIC`, `SUMMARIZATION`, `USER_PREFERENCE`, `CUSTOM` |
| `--expiry <days>` | Event expiry (default: 30) |
| `--owner <agent>` | Owning agent |
| `--users <agents>` | Comma-separated users |
| `--json` | JSON output |

### add identity

Add an identity provider (API key).
Add a credential provider (API key). Credentials are top-level resources in the flat resource model.

```bash
agentcore add identity \
 --name OpenAI \
 --type ApiKeyCredentialProvider \
 --api-key sk-... \
 --owner MyAgent
 --api-key sk-...
```

| Flag | Description |
| ------------------ | -------------------------- |
| `--name <name>` | Identity name |
| `--type <type>` | `ApiKeyCredentialProvider` |
| `--api-key <key>` | API key value |
| `--owner <agent>` | Owning agent |
| `--users <agents>` | Comma-separated users |
| `--json` | JSON output |
| Flag | Description |
| ----------------- | --------------- |
| `--name <name>` | Credential name |
| `--api-key <key>` | API key value |
| `--json` | JSON output |

### add target

Expand All@@ -213,21 +204,6 @@ agentcore add target \
| `--description <desc>` | Description |
| `--json` | JSON output |

### add bind

Connect resources to agents.

```bash
# Agent-to-agent
agentcore add bind agent --source CallerAgent --target HelperAgent

# Memory
agentcore add bind memory --agent MyAgent --memory SharedMemory --access read

# Identity
agentcore add bind identity --agent MyAgent --identity OpenAI
```

### remove

Remove resources from project.
Expand DownExpand Up@@ -315,15 +291,6 @@ agentcore package -d ./my-project
| `-d, --directory <path>` | Project directory |
| `-a, --agent <name>` | Package specific agent |

### outline

Display project resource tree.

```bash
agentcore outline
agentcore outline agent MyAgent
```

### update

Check for CLI updates.
Expand DownExpand Up@@ -354,7 +321,7 @@ agentcore deploy --target production -y --json
```bash
agentcore create --name MyProject --defaults
cd MyProject
agentcore add memory --name SharedMemory --strategies SEMANTIC --owner MyProject
agentcore add memory --name SharedMemory --strategies SEMANTIC
agentcore add target --name dev --account 123456789012 --region us-west-2
agentcore deploy --target dev -y
```
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
})();
chore: improve documentation by tejaskash · Pull Request #232 · aws/agentcore-cli · GitHub
Skip to content
chore: improve documentation#232

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

 Merged

aidandaly24
merged 2 commits into

from

Feb 10, 2026
 Merged


chore: improve documentation
#232
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
ef1259d

chore: improve documentation


tejaskash Feb 10, 2026
2be673e

fix: update snapshots for ONBOARDING.md and SCHEMA.md changes


tejaskash Feb 10, 2026

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


20 changes: 18 additions & 2 deletions
AGENTS.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,10 +23,26 @@ Note: CDK L3 constructs are in a separate package `@aws/agentcore-l3-cdk-constru
## CLI Commands

- `create` - Create new AgentCore project
- `add` - Add resources (agent, memory, identity, target)
- `remove` - Remove resources (agent, memory, identity, target, all)
- `deploy` - Deploy infrastructure to AWS
- `dev` - Local development server
- `invoke` - Invoke deployed agents
- `destroy` - Tear down deployed resources
- `status` - Check deployment status
- `dev` - Local development server
- `invoke` - Invoke agents (local or deployed)
- `package` - Package agent artifacts without deploying
- `validate` - Validate configuration files
- `update` - Check for CLI updates
- `help` - Display help information

### Agent Types

- **Template agents**: Created from framework templates (Strands, LangChain_LangGraph, GoogleADK, OpenAIAgents)
- **BYO agents**: Bring your own code with `agentcore add agent --type byo`

### Coming Soon

- MCP gateway and tool support (`add gateway`, `add mcp-tool`) - currently hidden

## Vended CDK Project

Expand Down

83 changes: 25 additions & 58 deletions
docs/commands.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,21 +30,21 @@ agentcore create --name MyProject --no-agent
agentcore create --name MyProject --defaults --dry-run
```

| Flag | Description |
| ---------------------- | ------------------------------------------------------------------------ |
| `--name <name>` | Project name (alphanumeric, max 23 chars) |
| `--defaults` | Use defaults (Python, Strands, Bedrock, no memory) |
| `--no-agent` | Skip agent creation |
| `--language <lang>` | `Python` or `TypeScript` |
| `--framework <fw>` | `Strands`, `LangChain_LangGraph`, `AutoGen`, `GoogleADK`, `OpenAIAgents` |
| `--model-provider <p>` | `Bedrock`, `Anthropic`, `OpenAI`, `Gemini` |
| `--api-key <key>` | API key for non-Bedrock providers |
| `--memory <opt>` | `none`, `shortTerm`, `longAndShortTerm` |
| `--output-dir <dir>` | Output directory |
| `--skip-git` | Skip git initialization |
| `--skip-python-setup` | Skip venv setup |
| `--dry-run` | Preview without creating |
| `--json` | JSON output |
| Flag | Description |
| ---------------------- | ------------------------------------------------------------- |
| `--name <name>` | Project name (alphanumeric, max 23 chars) |
| `--defaults` | Use defaults (Python, Strands, Bedrock, no memory) |
| `--no-agent` | Skip agent creation |
| `--language <lang>` | `Python` or `TypeScript` |
| `--framework <fw>` | `Strands`, `LangChain_LangGraph`, `GoogleADK`, `OpenAIAgents` |
| `--model-provider <p>` | `Bedrock`, `Anthropic`, `OpenAI`, `Gemini` |
| `--api-key <key>` | API key for non-Bedrock providers |
| `--memory <opt>` | `none`, `shortTerm`, `longAndShortTerm` |
| `--output-dir <dir>` | Output directory |
| `--skip-git` | Skip git initialization |
| `--skip-python-setup` | Skip venv setup |
| `--dry-run` | Preview without creating |
| `--json` | JSON output |

### deploy

Expand DownExpand Up@@ -151,15 +151,13 @@ agentcore add agent \

### add memory

Add a memory resource.
Add a memory resource. Memory is a top-level resource in the flat resource model.

```bash
agentcore add memory \
 --name SharedMemory \
 --strategies SEMANTIC,SUMMARIZATION \
 --expiry 30 \
 --owner MyAgent \
 --users AgentA,AgentB
 --expiry 30
```

| Flag | Description |
Expand All@@ -168,30 +166,23 @@ agentcore add memory \
| `--description <desc>` | Description |
| `--strategies <types>` | Comma-separated: `SEMANTIC`, `SUMMARIZATION`, `USER_PREFERENCE`, `CUSTOM` |
| `--expiry <days>` | Event expiry (default: 30) |
| `--owner <agent>` | Owning agent |
| `--users <agents>` | Comma-separated users |
| `--json` | JSON output |

### add identity

Add an identity provider (API key).
Add a credential provider (API key). Credentials are top-level resources in the flat resource model.

```bash
agentcore add identity \
 --name OpenAI \
 --type ApiKeyCredentialProvider \
 --api-key sk-... \
 --owner MyAgent
 --api-key sk-...
```

| Flag | Description |
| ------------------ | -------------------------- |
| `--name <name>` | Identity name |
| `--type <type>` | `ApiKeyCredentialProvider` |
| `--api-key <key>` | API key value |
| `--owner <agent>` | Owning agent |
| `--users <agents>` | Comma-separated users |
| `--json` | JSON output |
| Flag | Description |
| ----------------- | --------------- |
| `--name <name>` | Credential name |
| `--api-key <key>` | API key value |
| `--json` | JSON output |

### add target

Expand All@@ -213,21 +204,6 @@ agentcore add target \
| `--description <desc>` | Description |
| `--json` | JSON output |

### add bind

Connect resources to agents.

```bash
# Agent-to-agent
agentcore add bind agent --source CallerAgent --target HelperAgent

# Memory
agentcore add bind memory --agent MyAgent --memory SharedMemory --access read

# Identity
agentcore add bind identity --agent MyAgent --identity OpenAI
```

### remove

Remove resources from project.
Expand DownExpand Up@@ -315,15 +291,6 @@ agentcore package -d ./my-project
| `-d, --directory <path>` | Project directory |
| `-a, --agent <name>` | Package specific agent |

### outline

Display project resource tree.

```bash
agentcore outline
agentcore outline agent MyAgent
```

### update

Check for CLI updates.
Expand DownExpand Up@@ -354,7 +321,7 @@ agentcore deploy --target production -y --json
```bash
agentcore create --name MyProject --defaults
cd MyProject
agentcore add memory --name SharedMemory --strategies SEMANTIC --owner MyProject
agentcore add memory --name SharedMemory --strategies SEMANTIC
agentcore add target --name dev --account 123456789012 --region us-west-2
agentcore deploy --target dev -y
```
Expand Down
Loading
Loading