Skip to content

Commit 877e90c

Browse files
PedroGuerraPTgithub-actions[bot]
authored andcommitted
Update docs content from https://github.com/depot/app
1 parent 058c364 commit 877e90c

37 files changed

Lines changed: 2890 additions & 336 deletions

content/ai-at-depot.mdx

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
---
2+
title: AI and agent resources
3+
ogTitle: AI features and resources at Depot
4+
description: Learn about AI-based features in Depot and resources available for agents and LLMs.
5+
---
6+
7+
Depot uses AI in two complementary ways: product features that help people use Depot and machine-readable resources that help agents use Depot.
8+
9+
## AI product features
10+
11+
We integrate AI into Depot so that you can find information and debug issues faster. We never use your data (usage or logs) to train models.
12+
13+
### Sherlock - Depot AI assistant
14+
15+
Sherlock is Depot's AI assistant, available in the public docs and in the Depot dashboard. It answers questions about the Depot platform. In the docs it cites the pages it used. In the dashboard it adds authenticated context and infers the resource you mean from the page you're on, so on a build page you can ask "why did this build fail?" without copying anything. What it can do depends on where you ask.
16+
17+
Open Sherlock from the **Ask AI** button in the dashboard sidebar, from **Analyze Build** or **Analyze Job** on a build or GitHub Actions job page, or from the **Ask Sherlock** link on a [Depot CI AI error summary](/docs/ai-at-depot#ai-error-summaries-in-depot-ci). Use it when you want a natural-language path through Depot docs or your dashboard data. Use the CLI or API when you need deterministic automation.
18+
19+
#### What Sherlock can do
20+
21+
Available to everyone, including logged-out docs visitors:
22+
23+
- Search and read Depot documentation and blog posts.
24+
- Check Depot system status and active incidents.
25+
26+
Added when you're signed in to the dashboard, scoped to resources in organizations you belong to:
27+
28+
- Fetch details and logs for builds, GitHub Actions jobs, and Depot CI workflows and jobs, including AI failure summaries.
29+
- Read project and organization settings, usage and analytics, registry information, and cache summaries.
30+
- Open a support ticket with context from your conversation, after you confirm it.
31+
32+
### AI error summaries in Depot CI
33+
34+
Depot CI generates an AI error summary after a job attempt fails. The summary appears in the workflow log viewer and includes what went wrong and a suggested next step or fix.
35+
36+
The summary also stores relevant log lines so the dashboard can link the diagnosis back to the failed step. Behind the scenes, Depot waits briefly for job logs to flush, reads the tail of the failed attempt logs, includes the failed step and any error annotation, and asks the model for a diagnosis, possible fix, and relevant line references. Log content sent for analysis has already gone through the worker's secret masking before being stored.
37+
38+
## Agent resources
39+
40+
### Skills
41+
42+
[Depot skills](https://github.com/depot/skills) give AI coding agents the product context they need to use Depot from a shell. To install Depot skills:
43+
44+
```bash
45+
npx skills add depot/skills
46+
```
47+
48+
The skills cover four areas:
49+
50+
- General Depot usage
51+
- Depot CI
52+
- Container builds
53+
- GitHub Actions runners
54+
55+
Skills are especially useful when an agent is iterating in Depot CI. See [Use Depot CI in coding agent loops](/docs/ci/how-to-guides/coding-agents) for a complete example.
56+
57+
### Depot CI for coding agents
58+
59+
[Depot CI](/docs/ci/overview) is built for programmatic use and is a natural fit for AI coding agents. Instead of the usual push-wait-guess cycle, an agent can run CI locally, read the failure, fix the code, and rerun, all in a closed loop from the terminal.
60+
61+
The key is `depot ci run`: it tests workflows against your local working tree without a commit or push, so an agent can iterate in a tight loop without polluting git history or waiting on remote CI. Paired with `depot ci status`, `depot ci logs`, and `depot ci ssh`, an agent can run a job, read the error, optionally drop into the running sandbox to debug, fix the code, and rerun until the build is green.
62+
63+
Install [Depot skills](https://github.com/depot/skills) first so the agent knows the `depot ci` commands and how to drive the loop.
64+
65+
- See [Use Depot CI in coding agent loops](/docs/ci/how-to-guides/coding-agents) for an example.
66+
- See the [Depot CI CLI reference](/docs/cli/reference/depot-ci) for the full set of `depot ci` commands your agent can run.
67+
- For agents that integrate over HTTP instead of a shell, the [Depot CI API](/docs/api/ci/reference) exposes the same operations: dispatching workflows, checking run status, fetching logs and metrics, and retrying jobs.
68+
69+
### Markdown
70+
71+
Every documentation, blog, changelog, and customer page is also available as raw Markdown. There are three ways to get it:
72+
73+
- **Add `.md` to the URL.** For example, [`https://depot.dev/docs/ci/quickstart.md`](https://depot.dev/docs/ci/quickstart.md) returns the Markdown source of the Depot CI quickstart.
74+
- **Use the Copy markdown button.** Every docs page has a **Copy markdown** control next to **Edit on GitHub** that copies the page's Markdown source to your clipboard, ready to paste into an AI tool.
75+
- **Negotiate for it.** A request to any `/docs/...` page with an `Accept: text/markdown` header returns Markdown instead of HTML.
76+
77+
### `llms.txt`
78+
79+
Depot publishes two LLM-oriented text resources:
80+
81+
- [`/llms.txt`](/llms.txt): an index of documentation, blog posts, changelog entries, and customer pages with titles, URLs, and descriptions.
82+
- [`/llms-all.txt`](/llms-all.txt): a concatenated Markdown export of all documentation pages.
83+
84+
Use `/llms.txt` when an agent needs to discover the right page first. Use `/llms-all.txt` when an agent needs the full documentation corpus in one text file.
85+
86+
## Getting help
87+
88+
If you can't find what you need, reach out to [Support](https://depot.dev/help) or join our [Discord](https://discord.gg/depot) community.

content/api/authentication.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ To authenticate with the Depot API you must pass the token in the `Authorization
2626
import {depot} from '@depot/sdk-node'
2727

2828
const headers = {
29-
Authorization: `Bearer ${process.env.DEPOT_API_TOKEN}`,
29+
Authorization: `Bearer ${process.env.DEPOT_TOKEN}`,
3030
}
3131

3232
async function example() {

content/api/overview.mdx

Lines changed: 32 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,45 @@
11
---
22
title: Depot API Overview
33
ogTitle: Overview of the Depot API
4-
description: Create and manage Depot projects and builders for running image builds on behalf of your own users.
4+
description: Programmatic access to Depot, from running container image builds on behalf of your own users to managing Depot CI workflows, runs, and jobs.
55
---
66

7-
The Depot API is a collection of endpoints that grant access to the underlying architecture. Organizations can manage projects, acquire BuildKit endpoints, and run image builds for their applications or services programmatically.
7+
import {NoteCallout} from '~/components/blog/NoteCallout'
88

9-
The API uses Connect, offering [multiprotocol support](https://connectrpc.com/docs/introduction#seamless-multi-protocol-support) for gRPC and HTTP JSON. Depot provides the following SDKs for interacting with the API:
9+
The Depot APIs are collections of endpoints that grant access to the underlying architecture and primitives. The APIs use Connect, offering [multiprotocol support](https://connectrpc.com/docs/introduction#seamless-multi-protocol-support) for gRPC and HTTP JSON.
1010

11-
- [Node](https://github.com/depot/sdk-node)
12-
- [Go](https://github.com/depot/depot-go)
11+
## Depot CI API
12+
13+
[Depot CI](/docs/ci/overview) has its own API for working with workflows programmatically: dispatching and rerunning workflows, listing runs, checking status, fetching logs and metrics, retrying and cancelling jobs, and downloading artifacts. See the [Depot CI API reference](/docs/api/ci/reference) for all endpoints and examples.
14+
15+
## Container Builds API
16+
17+
Organizations can manage projects, acquire BuildKit endpoints, and run image builds for their applications or services programmatically. Depot provides the following SDKs for interacting with the Container Builds API:
18+
19+
- [`depot/sdk-node`](https://github.com/depot/sdk-node)
20+
- [`depot/depot-go`](https://github.com/depot/depot-go)
1321

1422
For detailed documentation on all available endpoints, parameters, and examples, see the [SDK Reference](/docs/api/sdk-reference).
1523

16-
## Authentication
24+
### Security
1725

18-
Authenticate to the API using an `Authorization` header with an Organization Token that you generate in your [organization settings](/orgs/_/settings). See the [Authentication docs](/docs/api/authentication) for more details.
26+
If you're using the Container Builds API to build untrusted code, you need **one Depot project per customer entity in your organization**. A separate project per customer ensures secure cache isolation so that one customer's build can't access another customer's build cache.
27+
28+
## Sandbox API
1929

20-
## Security
30+
<NoteCallout variant="beta" title>
31+
The Sandbox SDK is in private beta. Methods might change before the SDK becomes generally available. Sandboxes are
32+
billed per vCPU-second at the Depot CI compute rate. [Contact us](/help) to request access for your organization.
33+
</NoteCallout>
2134

22-
If you're using the Depot API to build untrusted code, you need **one Depot project per customer entity in your organization**. A separate project per customer ensures secure cache isolation so that one customer's build can't access another customer's build cache.
35+
Run untrusted or agent-generated code in isolated, ephemeral sandboxes: create a sandbox, run commands and stream their output, and work with the sandbox file system through a `node:fs/promises`-shaped interface. Depot provides the following SDK for interacting with the Sandbox API:
36+
37+
- [`depot/sandbox-sdk`](https://github.com/depot/sandbox-sdk)
38+
39+
For detailed documentation on all available methods, parameters, and examples, see the [Sandbox SDK reference](/docs/api/sandbox-sdk-reference).
40+
41+
Sandboxes are billed by compute usage, at the same per-second rate as Depot CI compute: the number of vCPUs you request x how long the sandbox runs, with no one-minute minimum. See the Depot CI sandbox table on the [pricing page](/pricing) for details.
42+
43+
## Authentication
44+
45+
Authenticate to the API using an `Authorization` header with an Organization Token that you generate in your [organization settings](/orgs/_/settings). See the [Authentication docs](/docs/api/authentication) for more details.

0 commit comments

Comments
 (0)