> ## Documentation Index
> Fetch the complete documentation index at: https://openfga.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Install SDK Client

> Installing SDK client

To get started, install the OpenFGA SDK packages. These commands select the exact versions used by the API reference samples.

The API reference provides SDK programs for 18 standard operations and cURL for all 24 operations. The six experimental AuthZen endpoints are **HTTP-only** in these SDK versions: `GetConfiguration`, `Evaluation`, `Evaluations`, `ActionSearch`, `ResourceSearch`, and `SubjectSearch`. Use their cURL samples; no named SDK methods are available for these endpoints.

<Tabs>
  <Tab title="Node.js">
    You can find the Node.js package on npm at: [@openfga/sdk](https://www.npmjs.com/package/@openfga/sdk).

    Using [npm](https://www.npmjs.com/):

    ```bash theme={"system"}
    npm install @openfga/sdk@0.9.7
    ```

    Using [yarn](https://yarnpkg.com):

    ```bash theme={"system"}
    yarn add @openfga/sdk@0.9.7
    ```
  </Tab>

  <Tab title="Go" id="go-sdk">
    You can find the Go package on GitHub at: [@openfga/go-sdk](https://github.com/openfga/go-sdk).
    This SDK version requires Go 1.25 or newer.

    To install:

    ```bash theme={"system"}
    go get github.com/openfga/go-sdk@v0.8.2
    ```

    In your code, import the module and use it:

    ```go theme={"system"}
    import (
        openfga "github.com/openfga/go-sdk"
    )

    func main() {
        configuration, err := openfga.NewConfiguration(openfga.Configuration{
            ApiUrl: os.Getenv("FGA_API_URL"), // required, e.g. https://api.fga.example
        })
        if err != nil {
            // .. Handle error
        }
    }
    ```

    You can then run

    ```bash theme={"system"}
    go mod tidy
    ```

    to update `go.mod` and `go.sum` if you are using them.
  </Tab>

  <Tab title=".NET">
    The OpenFGA .NET SDK is available on [NuGet](https://www.nuget.org/packages/OpenFga.Sdk).
    The API reference programs use top-level statements and async streams; use a .NET 8 or newer application.

    You can install it using:

    * The [dotnet CLI](https://docs.microsoft.com/en-us/nuget/consume-packages/install-use-packages-dotnet-cli):

    ```bash theme={"system"}
    dotnet add package OpenFGA.Sdk --version 0.10.4
    ```

    * The [Package Manager Console](https://docs.microsoft.com/en-us/nuget/consume-packages/install-use-packages-powershell) inside Visual Studio:

    ```powershell theme={"system"}
    Install-Package OpenFGA.Sdk -Version 0.10.4
    ```

    * [Visual Studio](https://docs.microsoft.com/en-us/nuget/consume-packages/install-use-packages-visual-studio), [Visual Studio for Mac](https://docs.microsoft.com/en-us/visualstudio/mac/nuget-walkthrough) and [IntelliJ Rider](https://www.jetbrains.com/help/rider/Using_NuGet.html): Search for and install `OpenFGA.Sdk` in each of their respective package manager UIs.
  </Tab>

  <Tab title="Python">
    The OpenFGA Python SDK is available on [PyPI](https://pypi.org/project/openfga-sdk).

    To install:

    ```bash theme={"system"}
    pip3 install openfga_sdk==0.10.4
    ```

    In your code, import the module and use it:

    ```python theme={"system"}
    import openfga_sdk
    ```
  </Tab>

  <Tab title="Java">
    You can find the Java package on [Maven Central](https://central.sonatype.com/artifact/dev.openfga/openfga-sdk).
    This SDK version requires Java 17 or newer.

    Using [Maven](https://maven.apache.org/):

    ```xml theme={"system"}
    <dependency>
        <groupId>dev.openfga</groupId>
        <artifactId>openfga-sdk</artifactId>
        <version>0.10.0</version>
    </dependency>
    ```

    Using [Gradle](https://gradle.org/):

    ```groovy theme={"system"}
    implementation 'dev.openfga:openfga-sdk:0.10.0'
    ```
  </Tab>

  <Tab title="CLI">
    The OpenFGA CLI is available on [GitHub](https://github.com/openfga/cli).

    To install:

    <h3 id="brew">Brew</h3>

    ```bash theme={"system"}
    brew install openfga/tap/fga
    ```

    <h3 id="linux-deb-rpm-and-apk-packages">Linux (deb, rpm and apk) packages</h3>

    Download the .deb, .rpm or .apk packages from the [releases page](https://github.com/openfga/cli/releases).

    Debian:

    ```bash theme={"system"}
    sudo apt install ./fga_<version>_linux_<arch>.deb
    ```

    Fedora:

    ```bash theme={"system"}
    sudo dnf install ./fga_<version>_linux_<arch>.rpm
    ```

    Alpine Linux:

    ```bash theme={"system"}
    sudo apk add --allow-untrusted ./fga_<version>_linux_<arch>.apk
    ```

    <h3 id="docker">Docker</h3>

    ```bash theme={"system"}
    docker pull openfga/cli; docker run -it openfga/cli
    ```

    <h3 id="go">Go</h3>

    ```bash theme={"system"}
    go install github.com/openfga/cli/cmd/fga@latest
    ```

    <h3 id="manually">Manually</h3>

    Download the pre-compiled binaries from the [releases page](https://github.com/openfga/cli/releases).
  </Tab>
</Tabs>

## Related Sections

Get OpenFGA's SDKs to add authorization to your API.

<CardGroup>
  <Card title="OpenFGA Node.js SDK" href="https://www.npmjs.com/package/@openfga/sdk">
    Install our Node.js & JavaScript SDK to get started.
  </Card>

  <Card title="OpenFGA Go SDK" href="https://github.com/openfga/go-sdk">
    Use our Go SDK to easily connect your Go application to the OpenFGA API
  </Card>

  <Card title="OpenFGA .NET SDK" href="https://github.com/openfga/dotnet-sdk">
    Connect your .NET service with OpenFGA using our .NET SDK
  </Card>

  <Card title="OpenFGA Python SDK" href="https://github.com/openfga/python-sdk">
    Connect your Python service with OpenFGA using our Python SDK
  </Card>

  <Card title="OpenFGA Java SDK" href="https://github.com/openfga/java-sdk">
    Connect your Java service with OpenFGA using our Java SDK
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.