Skip to content

Commit ad1dc10

Browse files
jenna-winklergemini-code-assist[bot]
authored andcommitted
docs: cleanup (i-am-bee#1586)
* docs: updates Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Jenna Winkler <[email protected]> * Update docs/docs.json Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Jenna Winkler <[email protected]> * Update authenticate-cli-to-server.mdx Signed-off-by: Jenna Winkler <[email protected]> * Update README.md Signed-off-by: Jenna Winkler <[email protected]> * docs: updates --------- Signed-off-by: Jenna Winkler <[email protected]> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Eden Gilbert <[email protected]>
1 parent 94e9231 commit ad1dc10

24 files changed

+96
-106
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ agentstack run example_agent "Alice" # Test your agent
8585
You should see: "Ciao Alice!" 🎉
8686

8787
> [!TIP]
88-
> Check out [Start Building Agents](https://agentstack.beeai.dev/introduction/start-building-agents) for a complete step-by-step guide to creating your first agent.
88+
> Check out [Building Agents](https://agentstack.beeai.dev/guides/building-agents) for a complete step-by-step guide to creating your first agent.
8989
9090
---
9191

docs/docs.json

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,17 @@
1212
"groups": [
1313
{
1414
"group": "Introduction",
15-
"pages": ["introduction/welcome", "introduction/quickstart"]
15+
"pages": [
16+
"introduction/welcome",
17+
"introduction/quickstart"
18+
]
1619
},
1720
{
1821
"group": "Deploy to Agent Stack",
1922
"pages": [
20-
"deploy/wrap-existing-agents",
21-
"introduction/start-building-agents",
22-
"deploy/deploy-your-agents"
23+
"guides/wrap-existing-agents",
24+
"guides/building-agents",
25+
"guides/deploy-your-agents"
2326
]
2427
},
2528

@@ -30,32 +33,35 @@
3033
"guides/messages",
3134
"guides/multi-turn",
3235
"guides/files",
33-
"extensions/agent-details",
34-
"extensions/llm-proxy-service",
35-
"extensions/trajectory",
36-
"extensions/citations",
37-
"extensions/forms",
38-
"extensions/agent-settings",
39-
"extensions/secrets",
40-
"extensions/rag",
41-
"extensions/mcp-oauth",
42-
"extensions/mcp"
36+
"sdk/agent-details",
37+
"sdk/llm-proxy-service",
38+
"sdk/trajectory",
39+
"sdk/citations",
40+
"sdk/forms",
41+
"sdk/agent-settings",
42+
"sdk/secrets",
43+
"sdk/rag",
44+
"sdk/mcp-oauth",
45+
"sdk/mcp"
4346
]
4447
},
4548
{
4649
"group": "Guides",
4750
"pages": [
4851
"guides/cli-reference",
4952
"guides/observability",
50-
"introduction/connect-a2a-agents"
53+
"guides/connect-a2a-agents"
5154
]
5255
},
5356
{
5457
"group": "Deploy Agent Stack for Your Team",
55-
"pages": ["how-to/deployment-guide", "how-to/remote-cli-guide"]
58+
"pages": [
59+
"guides/deployment-guide",
60+
"guides/authenticate-cli-to-server"
61+
]
5662
},
5763
{
58-
"group": "Integrating with Agent Stack",
64+
"group": "Advanced Integration",
5965
"pages": ["guides/connectors"]
6066
},
6167

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
title: "Connect CLI to Remote Server"
3+
description: "Connect the Agent Stack CLI to your deployed server"
4+
---
5+
6+
Use the Agent Stack CLI to configure and manage remote Agent Stack deployments. Agent Stack follows a client-server architecture, where the CLI acts as a client connecting to a deployed Agent Stack server. This allows you to manage agents remotely from your local machine.
7+
8+
## Prerequisites
9+
10+
- Agent Stack CLI installed locally ([Quickstart](/introduction/quickstart))
11+
- URL of your deployed Agent Stack server
12+
- Authentication credentials for the server
13+
14+
## Connect to a server
15+
16+
Run this command to connect to a remote server:
17+
18+
```bash
19+
agentstack server login
20+
```
21+
22+
The CLI will prompt you for:
23+
- Server URL
24+
- Authentication credentials
25+
26+
Once authenticated, the CLI connects to your specified server and saves the connection for future commands.
27+
28+
## View connected servers
29+
30+
List all servers you've connected to:
31+
32+
```bash
33+
agentstack server list
34+
```
35+
36+
This shows all saved server connections. The active server is marked in the output.
37+
38+
## Switch between servers
39+
40+
To switch to a different connected server:
41+
42+
```bash
43+
agentstack server select
44+
```
45+
46+
Select from your saved connections.
47+
48+
## Disconnect from a server
49+
50+
Remove the currently active server connection:
51+
52+
```bash
53+
agentstack server logout
54+
```
55+
56+
This removes the server from your saved connections. To disconnect from a different server, switch to it first, then logout.
File renamed without changes.

docs/guides/cli-reference.mdx

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -155,13 +155,22 @@ agentstack build . --dockerfile ./custom.Dockerfile
155155

156156
### server-side-build
157157

158-
**EXPERIMENTAL:** Build agent from GitHub repository in the platform:
158+
**EXPERIMENTAL:** Build an agent from a GitHub repository on the platform, instead of locally.
159+
160+
This is useful if you don’t want to set up a local build environment or if you want to ensure the build happens in a consistent, controlled server environment.
159161

160162
```bash
161-
agentstack server-side-build <github-url>
163+
agentstack server-side-build [OPTIONS] <github-url>
162164
```
163165

164-
This builds the agent on the server side rather than locally.
166+
This command clones the GitHub repository, builds the agent image on the platform, and optionally adds the built agent to your workspace.
167+
168+
**Options:**
169+
| Option | Description |
170+
| --------------------- | ---------------------------------------------------------------------------------------------------------- |
171+
| `--dockerfile <path>` | Use a custom Dockerfile path. Path should be relative to the repo root or a subdirectory. |
172+
| `--replace <id/name>` | Replace an existing agent. Accepts short agent ID, agent name, or part of the provider location. |
173+
| `--add / --no-add` | After the build completes, automatically add the agent to your Agent Stack instance. Default: `--no-add`. |
165174

166175
## Model Commands
167176

File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)