diff --git a/README.md b/README.md index d0a4b00be..0f206a14c 100644 --- a/README.md +++ b/README.md @@ -85,7 +85,7 @@ agentstack run example_agent "Alice" # Test your agent You should see: "Ciao Alice!" 🎉 > [!TIP] -> 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. +> Check out [Building Agents](https://agentstack.beeai.dev/guides/building-agents) for a complete step-by-step guide to creating your first agent. --- diff --git a/docs/docs.json b/docs/docs.json index b640f5ab8..025b9c338 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -12,14 +12,17 @@ "groups": [ { "group": "Introduction", - "pages": ["introduction/welcome", "introduction/quickstart"] + "pages": [ + "introduction/welcome", + "introduction/quickstart" + ] }, { "group": "Deploy to Agent Stack", "pages": [ - "deploy/wrap-existing-agents", - "introduction/start-building-agents", - "deploy/deploy-your-agents" + "guides/wrap-existing-agents", + "guides/building-agents", + "guides/deploy-your-agents" ] }, @@ -30,16 +33,16 @@ "guides/messages", "guides/multi-turn", "guides/files", - "extensions/agent-details", - "extensions/llm-proxy-service", - "extensions/trajectory", - "extensions/citations", - "extensions/forms", - "extensions/agent-settings", - "extensions/secrets", - "extensions/rag", - "extensions/mcp-oauth", - "extensions/mcp" + "sdk/agent-details", + "sdk/llm-proxy-service", + "sdk/trajectory", + "sdk/citations", + "sdk/forms", + "sdk/agent-settings", + "sdk/secrets", + "sdk/rag", + "sdk/mcp-oauth", + "sdk/mcp" ] }, { @@ -47,15 +50,18 @@ "pages": [ "guides/cli-reference", "guides/observability", - "introduction/connect-a2a-agents" + "guides/connect-a2a-agents" ] }, { "group": "Deploy Agent Stack for Your Team", - "pages": ["how-to/deployment-guide", "how-to/remote-cli-guide"] + "pages": [ + "guides/deployment-guide", + "guides/authenticate-cli-to-server" + ] }, { - "group": "Integrating with Agent Stack", + "group": "Advanced Integration", "pages": ["guides/connectors"] }, diff --git a/docs/guides/authenticate-cli-to-server.mdx b/docs/guides/authenticate-cli-to-server.mdx new file mode 100644 index 000000000..ec5e42d8b --- /dev/null +++ b/docs/guides/authenticate-cli-to-server.mdx @@ -0,0 +1,56 @@ +--- +title: "Connect CLI to Remote Server" +description: "Connect the Agent Stack CLI to your deployed server" +--- + +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. + +## Prerequisites + +- Agent Stack CLI installed locally ([Quickstart](/introduction/quickstart)) +- URL of your deployed Agent Stack server +- Authentication credentials for the server + +## Connect to a server + +Run this command to connect to a remote server: + +```bash +agentstack server login +``` + +The CLI will prompt you for: +- Server URL +- Authentication credentials + +Once authenticated, the CLI connects to your specified server and saves the connection for future commands. + +## View connected servers + +List all servers you've connected to: + +```bash +agentstack server list +``` + +This shows all saved server connections. The active server is marked in the output. + +## Switch between servers + +To switch to a different connected server: + +```bash +agentstack server select +``` + +Select from your saved connections. + +## Disconnect from a server + +Remove the currently active server connection: + +```bash +agentstack server logout +``` + +This removes the server from your saved connections. To disconnect from a different server, switch to it first, then logout. diff --git a/docs/introduction/start-building-agents.mdx b/docs/guides/building-agents.mdx similarity index 100% rename from docs/introduction/start-building-agents.mdx rename to docs/guides/building-agents.mdx diff --git a/docs/guides/cli-reference.mdx b/docs/guides/cli-reference.mdx index 906b9d26d..0012260a9 100644 --- a/docs/guides/cli-reference.mdx +++ b/docs/guides/cli-reference.mdx @@ -155,13 +155,22 @@ agentstack build . --dockerfile ./custom.Dockerfile ### server-side-build -**EXPERIMENTAL:** Build agent from GitHub repository in the platform: +**EXPERIMENTAL:** Build an agent from a GitHub repository on the platform, instead of locally. + +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. ```bash -agentstack server-side-build +agentstack server-side-build [OPTIONS] ``` -This builds the agent on the server side rather than locally. +This command clones the GitHub repository, builds the agent image on the platform, and optionally adds the built agent to your workspace. + +**Options:** +| Option | Description | +| --------------------- | ---------------------------------------------------------------------------------------------------------- | +| `--dockerfile ` | Use a custom Dockerfile path. Path should be relative to the repo root or a subdirectory. | +| `--replace ` | Replace an existing agent. Accepts short agent ID, agent name, or part of the provider location. | +| `--add / --no-add` | After the build completes, automatically add the agent to your Agent Stack instance. Default: `--no-add`. | ## Model Commands diff --git a/docs/introduction/connect-a2a-agents.mdx b/docs/guides/connect-a2a-agents.mdx similarity index 100% rename from docs/introduction/connect-a2a-agents.mdx rename to docs/guides/connect-a2a-agents.mdx diff --git a/docs/deploy/deploy-your-agents.mdx b/docs/guides/deploy-your-agents.mdx similarity index 100% rename from docs/deploy/deploy-your-agents.mdx rename to docs/guides/deploy-your-agents.mdx diff --git a/docs/how-to/deployment-guide.mdx b/docs/guides/deployment-guide.mdx similarity index 100% rename from docs/how-to/deployment-guide.mdx rename to docs/guides/deployment-guide.mdx diff --git a/docs/how-to/environment-configuration.mdx b/docs/guides/environment-configuration.mdx similarity index 100% rename from docs/how-to/environment-configuration.mdx rename to docs/guides/environment-configuration.mdx diff --git a/docs/how-to/mcp.mdx b/docs/guides/mcp.mdx similarity index 100% rename from docs/how-to/mcp.mdx rename to docs/guides/mcp.mdx diff --git a/docs/deploy/wrap-existing-agents.mdx b/docs/guides/wrap-existing-agents.mdx similarity index 100% rename from docs/deploy/wrap-existing-agents.mdx rename to docs/guides/wrap-existing-agents.mdx diff --git a/docs/how-to/remote-cli-guide.mdx b/docs/how-to/remote-cli-guide.mdx deleted file mode 100644 index ef39dfcef..000000000 --- a/docs/how-to/remote-cli-guide.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "Connect with CLI" -description: "Connect the Agent Stack CLI to remote servers" ---- - -The Agent Stack CLI is a handy tool for configuring and managing your Agent Stack installations. This guide will walk you through the steps to connect the CLI to remote servers. - -## Requirements - -- Agent Stack CLI installed on your local machine. -- Access to the remote server with Agent Stack installed. - -## Connecting to a remote server - -To connect the Agent Stack CLI to a new remote server or change the current one, execute the following command in your terminal: - -```bash -agentstack server login -``` - -The command will guide you through an interactive flow. You will be prompted to enter the URL of the remote server and your authentication credentials, if applicable. Once completed, the CLI will be connected to the specified remote server. - -## Listing the connected remote servers - -To view all the remote servers you have connected to using the Agent Stack CLI, run the following command: - -```bash -agentstack server list -``` - -## Removing a remote server - -To remove a remote server, make sure it is selected as your current server, then run: - -```bash -agentstack server logout -``` diff --git a/docs/how-to/web-interface.mdx b/docs/how-to/web-interface.mdx deleted file mode 100644 index 4d04b704f..000000000 --- a/docs/how-to/web-interface.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "Web Interface" -description: "User-friendly web interface designed for end users" ---- - -The Agent Stack web interface is a minimalist GUI built for simplicity and ease of use. It’s designed with end users in mind - especially teams and business users who want to run AI agents without touching the command line or diving into technical details. - -## Getting Started - -Launch the web interface: - -```bash -agentstack ui -``` - -This opens your browser to [http://localhost:8334](http://localhost:8334) where you can browse and run available agents. - -## What You'll See - -### Agent Types - -1. **Chat Agents**: Conversational interfaces -2. **Task Agents**: Single-purpose tools for specific jobs - -### What's Hidden - -The web interface only shows agents with proper user interfaces. Agents without UIs are hidden from the GUI but remain available through the command line. - -**Why?** This keeps the interface clean for business users while developers can still access everything via CLI during development. - -## Using the Interface - -1. **Browse Agents**: View available agents -2. **Select an Agent**: Click to open its interface -3. **Provide Input**: Interact with agents -4. **Get Results**: View outputs and download files as needed - -## Q&A - -**Q: Why don't I see all the agents from `agentstack list`?** -A: The web interface only shows agents designed for end users. Developers can access all agents via CLI. - -**Q: How do I add an agent to the web interface?** -A: Agents need UI metadata to appear. See the [Startin Building Agents](/introduction/start-building-agents) guide for developers. diff --git a/docs/introduction/welcome.mdx b/docs/introduction/welcome.mdx index 6cdc57b32..5a63fd92c 100644 --- a/docs/introduction/welcome.mdx +++ b/docs/introduction/welcome.mdx @@ -41,13 +41,13 @@ Your agents request infrastructure services at runtime through A2A protocol exte Get up and running in one command - - Run existing A2A-compatible agents for instance GUI + + Deploy your existing agents to Agent Stack - + Build your first agent with the SDK - + Deploy Agent Stack to Kubernetes for your team \ No newline at end of file diff --git a/docs/extensions/agent-details.mdx b/docs/sdk/agent-details.mdx similarity index 100% rename from docs/extensions/agent-details.mdx rename to docs/sdk/agent-details.mdx diff --git a/docs/extensions/agent-settings.mdx b/docs/sdk/agent-settings.mdx similarity index 100% rename from docs/extensions/agent-settings.mdx rename to docs/sdk/agent-settings.mdx diff --git a/docs/extensions/citations.mdx b/docs/sdk/citations.mdx similarity index 100% rename from docs/extensions/citations.mdx rename to docs/sdk/citations.mdx diff --git a/docs/extensions/forms.mdx b/docs/sdk/forms.mdx similarity index 100% rename from docs/extensions/forms.mdx rename to docs/sdk/forms.mdx diff --git a/docs/extensions/llm-proxy-service.mdx b/docs/sdk/llm-proxy-service.mdx similarity index 100% rename from docs/extensions/llm-proxy-service.mdx rename to docs/sdk/llm-proxy-service.mdx diff --git a/docs/extensions/mcp-oauth.mdx b/docs/sdk/mcp-oauth.mdx similarity index 100% rename from docs/extensions/mcp-oauth.mdx rename to docs/sdk/mcp-oauth.mdx diff --git a/docs/extensions/mcp.mdx b/docs/sdk/mcp.mdx similarity index 100% rename from docs/extensions/mcp.mdx rename to docs/sdk/mcp.mdx diff --git a/docs/extensions/rag.mdx b/docs/sdk/rag.mdx similarity index 100% rename from docs/extensions/rag.mdx rename to docs/sdk/rag.mdx diff --git a/docs/extensions/secrets.mdx b/docs/sdk/secrets.mdx similarity index 100% rename from docs/extensions/secrets.mdx rename to docs/sdk/secrets.mdx diff --git a/docs/extensions/trajectory.mdx b/docs/sdk/trajectory.mdx similarity index 100% rename from docs/extensions/trajectory.mdx rename to docs/sdk/trajectory.mdx