Share via

Agent 365 CLI

Important

You need to be part of the Frontier preview program to get early access to Microsoft Agent 365. Frontier connects you directly with Microsoft’s latest AI innovations. Frontier previews are subject to the existing preview terms of your customer agreements. As these features are still in development, their availability and capabilities may change over time.

Agent 365 CLI is a cross-platform command-line tool for deploying and managing Agent 365 applications on Azure.

Prerequisites

Before you begin, make sure you have the following prerequisites:

  • Custom client app registration - The CLI requires a custom client app in your Microsoft Entra ID tenant for authentication. See Custom client app registration for detailed setup instructions. You need the application (client) ID during configuration.
  • Azure subscription - Access to an Azure subscription where you can create resources.
  • Required permissions - Your account must have one of the following roles:

Note

During the a365 config init step (after installation), the CLI automatically validates your custom client app registration by checking that the app exists, has the required permissions, and has admin consent granted.

Tip

Different CLI commands require different roles or permissions. Each command reference page specifies the minimum role required. For example, see the setup command reference for its specific requirements.

Install the Agent 365 CLI

Use the following steps to install the Agent 365 CLI globally on your operating system.

Prerequisites

You must have .NET installed. (.NET 8.0 is recommended.)

Use dotnet tool install

Install the Agent 365 CLI by using the following command with the --prerelease parameter:

dotnet tool install --global Microsoft.Agents.A365.DevTools.Cli --prerelease

Important

The Agent 365 CLI is still in preview. Until the Agent 365 CLI becomes generally available, always use the --prerelease parameter to get the latest version with the most recent fixes and features. When the Agent 365 CLI becomes generally available, the --prerelease parameter won't be necessary.

For the latest instructions and available versions, visit the official NuGet page: Microsoft.Agents.A365.DevTools.Cli on NuGet.org

Verify installation

After installing the Agent 365 CLI, verify that it's properly installed by running the --help command:

a365 -h

This command displays the help information and confirms the CLI is ready to use.

Update

Update Agent 365 CLI by using the dotnet tool update command with the --prerelease parameter:

dotnet tool update --global Microsoft.Agents.A365.DevTools.Cli --prerelease

Note

To update Agent 365 CLI, you need an internet connection to access the latest NuGet package: Microsoft.Agents.A365.DevTools.Cli.

Uninstall

Uninstall Agent 365 CLI by using the dotnet tool uninstall command:

dotnet tool uninstall --global Microsoft.Agents.A365.DevTools.Cli

File locations

The default location for a tool's executable file depends on the operating system:

OS Path
Linux/macOS $HOME/.dotnet/tools
Windows %USERPROFILE%\.dotnet\tools

The SDK adds this location to your path when you first run it. So you can invoke global tools from any directory without specifying the tool location.

Tool access is user-specific, not machine global. A global tool is only available to the user that installs the tool.

Available commands

For the complete list of available commands, use the --help command or see Agent 365 CLI Reference.

Troubleshooting

This section provides information about how to troubleshoot errors with Agent 365 CLI.

Tip

Agent 365 Troubleshooting Guide contains high-level troubleshooting recommendations, best practices, and links to troubleshooting content for each part of the Agent 365 development lifecycle.

CLI-specific issues covered in this section:

Not found in NuGet feeds error when installing, updating, or uninstalling

Symptom: microsoft.agents.a365.devtools.cli is not found in NuGet feeds https://api.nuget.org/v3/index.json error when installing, updating, or uninstalling the Agent 365 CLI.

Solution: Use the --prerelease parameter.

All current versions of the CLI are prerelease versions.

# For installation
dotnet tool install --global Microsoft.Agents.A365.DevTools.Cli --prerelease

# For updates
dotnet tool update --global Microsoft.Agents.A365.DevTools.Cli --prerelease

For the latest instructions and available versions, visit the official NuGet page: Microsoft.Agents.A365.DevTools.Cli on NuGet.org

Agent doesn't appear in Teams

Create agent instances troubleshooting: Agent doesn't appear in Teams

Can't create agent instance in Teams

Create agent instances troubleshooting: Can't create agent instance in Teams

  • Last updated on