locally plugin

Preview

During Public Preview you can use the Team plan for free, and get an early-adopter discount at GA. Sign in

locally plugin

This page is part of the CLI Reference and is generated from the CLI's own help output, so it matches what locally plugin --help prints.

locally plugin

Manage Resource Provider plugins.

Usage

locally plugin [flags]
  locally plugin [command]

Flags

-h, --help[=true|false]   help for plugin

Subcommands

locally plugin install

Install Resource Provider plugins.

Install one, all, or recommended Resource Provider plugins.

Examples:
locally plugin install --name Microsoft.KeyVault
  locally plugin install --recommended
  locally plugin install --all

Usage

locally plugin install [flags]

Flags

--accept-sql-server-licence[=true|false]   Accept Microsoft's SQL Server licence, which the Azure SQL plugin needs, without being asked
      --all[=true|false]                         Install all available providers
  -h, --help[=true|false]                        help for install
      --name string                              Resource Provider namespace (e.g. Microsoft.KeyVault)
      --recommended[=true|false]                 Install all recommended providers

locally plugin list-available

List all available Resource Provider plugins from the catalog.

Usage

locally plugin list-available [flags]

Flags

-h, --help[=true|false]   help for list-available

locally plugin list-installed

List installed Resource Provider plugins.

Usage

locally plugin list-installed [flags]

Flags

-h, --help[=true|false]   help for list-installed

locally plugin list-not-installed

List available Resource Provider plugins that are not installed locally.

Usage

locally plugin list-not-installed [flags]

Flags

-h, --help[=true|false]   help for list-not-installed

locally plugin show

Show metadata for an installed Resource Provider plugin.

Prints an installed plugin's platform, release version, revision and date, API versions, features and notes. Works while Locally is stopped. Matching is case-insensitive.

For a namespace with no plugin installed, says whether it's built in, available in the catalog, or unknown.

Examples:
locally plugin show Microsoft.KeyVault
  locally plugin show microsoft.keyvault

Usage

locally plugin show <namespace> [flags]

Flags

-h, --help[=true|false]   help for show

locally plugin supports

Report whether this installation supports a provider or resource type.

Reports whether a resource provider namespace (Microsoft.KeyVault) or resource type (Microsoft.KeyVault/vaults) is supported, not implemented yet, or available to install from the catalog.

Works while Locally is stopped. Matching is case-insensitive.

Examples:
locally plugin supports Microsoft.KeyVault/vaults
  locally plugin supports microsoft.keyvault

Usage

locally plugin supports <namespace|resource type> [flags]

Flags

-h, --help[=true|false]   help for supports

locally plugin uninstall

Uninstall a Resource Provider plugin.

Uninstall a Resource Provider plugin.

Examples:
locally plugin uninstall --name Microsoft.KeyVault

Usage

locally plugin uninstall [flags]

Flags

-h, --help[=true|false]   help for uninstall
      --name string         Resource Provider namespace (e.g. Microsoft.KeyVault)

locally plugin update

Update installed Resource Provider plugins.

Check for updates and download new versions of all installed plugins.

A running 'locally build' keeps using the plugin it already launched. For the new version to take effect, reload the plugin from the Dashboard's plugins page (Settings > Plugins > Reload), or restart 'locally build'.

Examples:
locally plugin update
  locally plugin update --name Microsoft.KeyVault

Usage

locally plugin update [flags]

Flags

--all[=true|false]    Update all installed providers (the default when no flag is given)
  -h, --help[=true|false]   help for update
      --name string         Update only this Resource Provider namespace (e.g. Microsoft.KeyVault)
Preview

During Public Preview you can use the Team plan for free, and get an early-adopter discount at GA. Sign in

A local cloud for you and your AI agents.

Your Azure infrastructure, running on your machine. Deploy in seconds, break things freely, and ship to Azure when you're ready.