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

# Installation

> Install the SDK for your language from its package registry or from its public GitHub repository.

Every SDK can be installed two ways: from its language's **package registry**, or straight from its
**public GitHub repository**. Use the registry for released versions. Use GitHub for the latest code
on the main branch or a specific commit.

| Language | Package registry | GitHub repository |
| - | - | - |
| Python | [`exsited`](https://pypi.org/project/exsited/) on PyPI | [exsited/exsited-sdk-python](https://github.com/exsited/exsited-sdk-python) |
| JavaScript | [`exsited`](https://www.npmjs.com/package/exsited) on npm | [exsited/exsited-sdk-js](https://github.com/exsited/exsited-sdk-js) |
| PHP | [`exsited/exsited`](https://packagist.org/packages/exsited/exsited) on Packagist | [exsited/exsited-sdk-php](https://github.com/exsited/exsited-sdk-php) |
| Java | [`com.exsited:exsited`](https://central.sonatype.com/artifact/com.exsited/exsited) on Maven Central | [exsited/exsited-sdk-java](https://github.com/exsited/exsited-sdk-java) |
| .NET | [`Exsited`](https://www.nuget.org/packages/Exsited) on NuGet | [exsited/exsited-sdk-dotnet](https://github.com/exsited/exsited-sdk-dotnet) |
| Dart | [`exsited`](https://pub.dev/packages/exsited) on pub.dev | [exsited/exsited-sdk-dart](https://github.com/exsited/exsited-sdk-dart) |
| Go | [`github.com/exsited/exsited-sdk-go/v4`](https://pkg.go.dev/github.com/exsited/exsited-sdk-go/v4) | [exsited/exsited-sdk-go](https://github.com/exsited/exsited-sdk-go) |

## Install the SDK

> [tab] Python
>
> Requires Python 3.10 or newer.
>
> **From PyPI.** Pin the major version:
>
> ```bash theme={null}
> pip install "exsited>=4,<5"
> ```
>
> **From GitHub:**
>
> ```bash theme={null}
> pip install "git+https://github.com/exsited/exsited-sdk-python.git"
> ```
>
> Then import it:
>
> ```python theme={null}
> from exsited import build_client
> ```

> [tab] JavaScript
>
> Requires Node.js 18.17 or newer. The package has no runtime dependencies and ships its own
> TypeScript types, as ES modules and CommonJS.
>
> **From npm:**
>
> ```bash theme={null}
> npm install exsited
> ```
>
> **From GitHub.** npm builds the package as it installs it:
>
> ```bash theme={null}
> npm install github:exsited/exsited-sdk-js
> ```
>
> Then import it:
>
> ```js theme={null}
> import {buildClient} from 'exsited';
> ```

> [tab] PHP
>
> Requires PHP 8.2 or newer with the `ctype`, `curl`, `filter`, `json` and `mbstring` extensions,
> and Composer 2.
>
> **From Packagist:**
>
> ```bash theme={null}
> composer require exsited/exsited
> ```
>
> **From GitHub.** Add the repository, then require its main branch:
>
> ```bash theme={null}
> composer config repositories.exsited vcs https://github.com/exsited/exsited-sdk-php
> composer require exsited/exsited:dev-main
> ```
>
> Then import it:
>
> ```php theme={null}
> use Exsited\Client\ClientRegistry;
> ```

> [tab] Java
>
> Requires JDK 21 and Maven 3.9 or newer. The SDK has no dependencies.
>
> **From Maven Central.** Use the latest version shown on
> [Maven Central](https://central.sonatype.com/artifact/com.exsited/exsited):
>
> ```xml theme={null}
> <dependency>
>     <groupId>com.exsited</groupId>
>     <artifactId>exsited</artifactId>
>     <version>VERSION</version>
> </dependency>
> ```
>
> For Gradle, add the same coordinates to `build.gradle`:
>
> ```groovy theme={null}
> implementation 'com.exsited:exsited:VERSION'
> ```
>
> **From GitHub.** Build it into your local Maven repository, then add the same dependency with the
> version in the clone's `pom.xml`:
>
> ```bash theme={null}
> git clone https://github.com/exsited/exsited-sdk-java.git
> cd exsited-sdk-java
> mvn install -DskipTests
> ```
>
> Then import it:
>
> ```java theme={null}
> import com.exsited.client.ExsitedClient;
> ```

> [tab] .NET
>
> Requires the .NET SDK 8.0.100 or newer.
>
> **From NuGet:**
>
> ```bash theme={null}
> dotnet add package Exsited
> ```
>
> **From GitHub.** Pack the clone into a local folder, add it as a package source, then add the
> package:
>
> ```bash theme={null}
> git clone https://github.com/exsited/exsited-sdk-dotnet.git
> dotnet pack exsited-sdk-dotnet/src/Exsited -c Release -o ./exsited-packages
> dotnet nuget add source ./exsited-packages --name exsited-local
> dotnet add package Exsited
> ```
>
> Then import it:
>
> ```csharp theme={null}
> using Exsited.Client;
> ```

> [tab] Dart
>
> Requires Dart 3.5 or newer. The Flutter SDK includes Dart.
>
> **From pub.dev:**
>
> ```bash theme={null}
> dart pub add exsited
> ```
>
> **From GitHub:**
>
> ```bash theme={null}
> dart pub add exsited --git-url https://github.com/exsited/exsited-sdk-dart.git
> ```
>
> Then import it:
>
> ```dart theme={null}
> import 'package:exsited/exsited.dart';
> ```

> [tab] Go
>
> Requires Go 1.24 or newer. Go downloads modules from their repository, so both options use the
> same path.
>
> **A released version:**
>
> ```bash theme={null}
> go get github.com/exsited/exsited-sdk-go/v4@latest
> ```
>
> **The latest code on GitHub's main branch:**
>
> ```bash theme={null}
> go get github.com/exsited/exsited-sdk-go/v4@main
> ```
>
> Then import it:
>
> ```go theme={null}
> import exsited "github.com/exsited/exsited-sdk-go/v4"
> ```

## Updating

From a registry, update the package with your package manager, for example
`pip install -U "exsited>=4,<5"`, `npm update exsited`, `composer update exsited/exsited`,
`dotnet add package Exsited`, `dart pub upgrade exsited` or `go get -u github.com/exsited/exsited-sdk-go/v4`.
For Java, raise `<version>` in your `pom.xml`.

From GitHub, run the same install command again to take the newest commit. For Java and .NET, pull
the clone and run its build command again. Each SDK's `CHANGELOG.md` on GitHub lists what changed in
each release.


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