diff --git a/src/frontend/src/content/docs/get-started/aspire-skills.mdx b/src/frontend/src/content/docs/get-started/aspire-skills.mdx index 30bddf01a9..b6c0b64c9c 100644 --- a/src/frontend/src/content/docs/get-started/aspire-skills.mdx +++ b/src/frontend/src/content/docs/get-started/aspire-skills.mdx @@ -275,7 +275,7 @@ The Aspire CLI setup flow can offer companion options, but they aren't part of t Use `playwright-cli` when an agent needs to test or inspect a running frontend. For Playwright commands and options, see the [Playwright command line documentation](https://playwright.dev/docs/test-cli). :::caution[dotnet-inspect scope] -Use `dotnet-inspect` only when an agent needs to inspect .NET code or packages outside Aspire. If you're only working with Aspire APIs, use the Aspire CLI instead: `aspire docs api` already provides C# and TypeScript API docs from aspire.dev. +Use `dotnet-inspect` only when an agent needs to inspect .NET code or packages outside Aspire. If you're only working with Aspire APIs, use the Aspire CLI instead: `aspire docs api` already provides C#, TypeScript, and Go API docs from aspire.dev. ::: diff --git a/src/frontend/src/content/docs/reference/cli/commands/aspire-docs-api-get.mdx b/src/frontend/src/content/docs/reference/cli/commands/aspire-docs-api-get.mdx index 381e1cb27a..eef3827841 100644 --- a/src/frontend/src/content/docs/reference/cli/commands/aspire-docs-api-get.mdx +++ b/src/frontend/src/content/docs/reference/cli/commands/aspire-docs-api-get.mdx @@ -25,7 +25,7 @@ Use the [`aspire docs api list`](../aspire-docs-api-list/) command to browse ava - **``** - The identifier of the API reference entry to retrieve. Identifiers are path-based strings derived from the API route structure on `aspire.dev`, for example `csharp/aspire.hosting/iresourcebuilder-1` or `typescript/aspire.hosting.redis/addredis`. + The identifier of the API reference entry to retrieve. Identifiers are path-based strings derived from the API route structure on `aspire.dev`, for example `csharp/aspire.hosting/iresourcebuilder-1`, `typescript/aspire.hosting.redis/addredis`, or `go/aspire.hosting.redis/addredis`. Use [`aspire docs api list`](../aspire-docs-api-list/) or [`aspire docs api search`](../aspire-docs-api-search/) to discover valid identifiers. @@ -69,6 +69,12 @@ The following options are available: aspire docs api get typescript/aspire.hosting.redis/addredis ``` +- Get the API reference for a Go module symbol: + + ```bash title="Aspire CLI" + aspire docs api get go/aspire.hosting.redis/addredis + ``` + - Get API content in JSON format: ```bash title="Aspire CLI" diff --git a/src/frontend/src/content/docs/reference/cli/commands/aspire-docs-api-list.mdx b/src/frontend/src/content/docs/reference/cli/commands/aspire-docs-api-list.mdx index 363951c994..de652ab538 100644 --- a/src/frontend/src/content/docs/reference/cli/commands/aspire-docs-api-list.mdx +++ b/src/frontend/src/content/docs/reference/cli/commands/aspire-docs-api-list.mdx @@ -19,7 +19,7 @@ aspire docs api list [options] The `aspire docs api list` command lets you navigate the Aspire API reference catalog from [aspire.dev](https://aspire.dev) in a scoped, hierarchical way. Rather than returning the entire catalog at once, `list` returns only the direct children of the provided scope. -Start with a language root (`csharp` or `typescript`) to see the top-level packages or modules, then progressively narrow the scope to explore types, member groups, and individual members. +Start with a language root (`csharp`, `typescript`, or `go`) to see the top-level packages or modules, then progressively narrow the scope to explore types, member groups, and individual members. ## Arguments @@ -43,6 +43,14 @@ Start with a language root (`csharp` or `typescript`) to see the top-level packa | `typescript/` | Direct symbols in the module | | `typescript//` | Members under the symbol | + **Go scopes:** + + | Scope | Returns | + | --- | --- | + | `go` | Top-level Go modules | + | `go/` | Direct symbols in the module | + | `go//` | Members under the symbol | + If a scope has no children, `list` returns no results. ## Options @@ -97,6 +105,18 @@ The following options are available: aspire docs api list typescript/aspire.hosting ``` +- List all top-level Go modules: + + ```bash title="Aspire CLI" + aspire docs api list go + ``` + +- List symbols in a specific Go module: + + ```bash title="Aspire CLI" + aspire docs api list go/aspire.hosting + ``` + - List results in JSON format: ```bash title="Aspire CLI" diff --git a/src/frontend/src/content/docs/reference/cli/commands/aspire-docs-api-search.mdx b/src/frontend/src/content/docs/reference/cli/commands/aspire-docs-api-search.mdx index 7eacebe51b..ac023bdf02 100644 --- a/src/frontend/src/content/docs/reference/cli/commands/aspire-docs-api-search.mdx +++ b/src/frontend/src/content/docs/reference/cli/commands/aspire-docs-api-search.mdx @@ -36,7 +36,7 @@ The following options are available: - **`--language `** - Filter results to a specific language. Supported values are `csharp` and `typescript`. When omitted, results from all supported languages are returned. + Filter results to a specific language. Supported values are `csharp`, `typescript`, and `go`. When omitted, results from all supported languages are returned. - **`--format `** @@ -78,6 +78,12 @@ The following options are available: aspire docs api search "withReference" --language typescript ``` +- Search in Go only: + + ```bash title="Aspire CLI" + aspire docs api search "WithReference" --language go + ``` + - Search with a custom result limit: ```bash title="Aspire CLI" diff --git a/src/frontend/src/content/docs/reference/cli/commands/aspire-docs-api.mdx b/src/frontend/src/content/docs/reference/cli/commands/aspire-docs-api.mdx index 849aa9f38d..834d970500 100644 --- a/src/frontend/src/content/docs/reference/cli/commands/aspire-docs-api.mdx +++ b/src/frontend/src/content/docs/reference/cli/commands/aspire-docs-api.mdx @@ -19,7 +19,7 @@ aspire docs api [command] [options] The `aspire docs api` command group provides access to the Aspire API reference documentation published on [aspire.dev](https://aspire.dev). Unlike the [`aspire docs`](../aspire-docs/) commands that work with prose documentation pages, the `aspire docs api` commands are backed by the API reference index built from `aspire.dev`'s sitemap. -You can browse the API catalog by scope, search for specific types or members by keyword, or retrieve the full reference content for a specific API entry. Both C# and TypeScript API hierarchies are supported. +You can browse the API catalog by scope, search for specific types or members by keyword, or retrieve the full reference content for a specific API entry. The C#, TypeScript, and Go API hierarchies are supported. ## Options