# WithCommand

- Module: [Aspire.Hosting](/reference/api/go/aspire.hosting.md)
- Version: `17.0.0`
- Kind: `method`
- Defined on: [`Resource`](/reference/api/go/aspire.hosting/resource.md)
- Source: [GitHub](https://github.com/microsoft/aspire/tree/bcfa151cdca6d0a573f22d5d9c23f9c727cb3b2f)

Adds a resource command

## Remarks

The `WithCommand` method is used to add commands to the resource. Commands are displayed in the dashboard
and can be executed by a user using the dashboard UI.
When a command is executed, the `executeCommand` callback is called and is run inside the Aspire host.

## Definition

```go
func (Resource) WithCommand(
    name string,
    displayName string,
    executeCommand func(arg ExecuteCommandContext) *ExecuteCommandResult,
    options ...*WithCommandOptions,
) Resource
```

## Parameters

- `name` (`string`) -- The name of the command. The name uniquely identifies the command.
- `displayName` (`string`) -- The display name visible in UI.
- `executeCommand` (`func(arg ExecuteCommandContext) *ExecuteCommandResult`) -- A callback that is executed when the command is executed. The callback is run inside the Aspire host. The callback result is used to indicate success or failure in the UI.
- `options` (`...*WithCommandOptions`) -- optional settings, see [Options](#options)

## Options

Optional parameters are passed in a trailing `options ...*WithCommandOptions` argument.

- `CommandOptions` ([`*CommandOptions`](/reference/api/go/aspire.hosting/commandoptions.md)) -- Optional configuration for the command.

## Returns

[`Resource`](/reference/api/go/aspire.hosting/resource.md) -- The resource builder.

Returns a handle; failures surface later via `Err()`.

## Applies to

- [`CSharpAppResource`](/reference/api/go/aspire.hosting/csharpappresource.md)
- [`ContainerRegistryResource`](/reference/api/go/aspire.hosting/containerregistryresource.md)
- [`ContainerResource`](/reference/api/go/aspire.hosting/containerresource.md)
- [`DotnetToolResource`](/reference/api/go/aspire.hosting/dotnettoolresource.md)
- [`ExecutableResource`](/reference/api/go/aspire.hosting/executableresource.md)
- [`ExternalServiceResource`](/reference/api/go/aspire.hosting/externalserviceresource.md)
- [`ParameterResource`](/reference/api/go/aspire.hosting/parameterresource.md)
- [`ProjectResource`](/reference/api/go/aspire.hosting/projectresource.md)
