Edit

Install Kiota

  • Article

Kiota can be accessed in the following ways.

Download binaries

You can download the latest version for your operating system.

Operating system Download
Linux (x64) linux-x64.zip
macOS (arm64) osx-arm64.zip
macOS (x64) osx-x64.zip
Windows (x64) win-x64.zip
Windows (x86) win-x86.zip

All releases

Run in Docker

You can run Kiota in our Docker container with one of the following commands.

docker run -v /some/output/path:/app/output \
-v /some/input/description.yml:/app/openapi.yml \
mcr.microsoft.com/openapi/kiota generate --language csharp -n namespace-prefix

Tip

You can alternatively use the --openapi parameter with a URI instead of volume mapping.

To generate a SDK from an online OpenAPI description and into the current directory:

docker run -v ${PWD}:/app/output mcr.microsoft.com/openapi/kiota \
generate --language typescript -n gfx -d \
https://raw.githubusercontent.com/microsoftgraph/msgraph-sdk-powershell/dev/openApiDocs/v1.0/Mail.yml

Install as .NET tool

If you have the .NET SDK installed, you can install Kiota as a .NET tool.

Execute the following command to install the tool.

dotnet tool install --global Microsoft.OpenApi.Kiota

Run in browser

You can run kiota with a modern web browser by navigating to app.kiota.dev.

Note

This feature is experimental and performances for large API descriptions might be impacted, should you run into issues, we suggest you revert to using the CLI.

Build from source

  1. Clone the current repository.

  2. Install the .NET SDK 7.0.

  3. Open the solution with Visual Studio and right click publish --or-- execute the following command:

    dotnet publish ./src/kiota/kiota.csproj -c Release -p:PublishSingleFile=true -r win-x64

  4. Navigate to the output directory (usually under src/kiota/bin/Release/net7.0).

  5. Run kiota.exe ....

Note

Refer to .NET runtime identifier catalog so select the appropriate runtime for your platform.

Install the Visual Studio Code extension

  1. Open the Marketplace page of the extension
  2. Click on the Install button.

Next steps

For details on running Kiota, see Using the Kiota tool.