Skip to main content

​
Use an agent

1

Sign in

Go to app.guild.ai and sign in with your Google account.
2

Create a workspace

Click Workspaces in the sidebar, then New workspace. Give it a name.
3

Install an agent

Inside your workspace, go to Agents and click Add agent. Browse the catalog and install one — try github-issues if you have a GitHub integration, or any public agent.
4

Start a session

Go back to your workspace and click New session. Select your agent, type a message, and press Enter.The agent runs and responds in the session panel. It may ask clarifying questions or request access to services along the way.
To connect GitHub, Slack, Jira, or other services, go to your organization’s Settings > Credentials and click Connect for each service.

​
Build your own agent

Ready to build a custom agent? The Guild CLI handles the full workflow: create, test, save, publish.

​
Prerequisites

​
Install and authenticate

1

Authenticate with Google Cloud

Run this once with the Google account your Guild contact provided:
gcloud auth login
2

Install the CLI

Install from the tarball your team shared:
npm install -g guildai-cli-<version>.tgz
3

Authenticate with Guild

guild auth login
This opens your browser to sign in at app.guild.ai and configures your local npm registry for Guild packages.Verify:
guild auth status
# ✓ Authenticated
If something goes wrong, run guild doctor to diagnose your setup. See the CLI troubleshooting section for common issues.

​
Create, test, publish

1

Create the agent

mkdir hello-agent && cd hello-agent
guild agent init --name hello-agent --template LLM
This creates the agent in the Guild backend, initializes a local git repo, and pulls starter files:
hello-agent/
├── agent.ts          # Your agent code
├── package.json      # Dependencies (runtime packages are pre-configured)
├── tsconfig.json     # TypeScript config
├── guild.json        # Local config (managed by the CLI)
└── .gitignore
2

Edit the agent

Open agent.ts and replace the contents:
import { llmAgent, guildTools } from "@guildai/agents-sdk"

export default llmAgent({
  description: "A friendly greeting agent",
  tools: { ...guildTools },
  systemPrompt: `You are a friendly assistant. Greet users warmly and answer their questions.`,
  mode: "multi-turn",
})
mode: "multi-turn" keeps the conversation going after each response. llmAgent automatically includes userInterfaceTools, so the agent can interact with users without extra setup.
3

Test it

guild agent test --ephemeral
--ephemeral creates a temporary version for testing without saving. This opens an interactive chat session:
You: Hello!
Agent: Hello! Welcome — I'm happy to help. What can I do for you today?
Press Ctrl+C to exit.
4

Save and publish

guild agent save --message "First version" --wait --publish
  • --wait blocks until validation passes
  • --publish makes the agent available in the catalog
Your agent is live. Install it in a workspace to use it.

​
Next steps

CLI reference

Full development loop: templates, testing, publishing, troubleshooting.

Agent SDK

Build advanced agents with typed inputs, tool sets, and platform services.

LLM agents

Prompt-driven agents with tools — the simplest way to build.

Coded agents

Deterministic TypeScript agents for algorithmic workflows.