PHPackages                             jelix/gandi-v5 - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. jelix/gandi-v5

ActiveLibrary[API Development](/categories/api)

jelix/gandi-v5
==============

Library and cli script to use the Gandi API V5

v1.1.0(10mo ago)51.1k3MITPHPPHP ^7.2.5 || ^8.0

Since Dec 5Pushed 10mo ago1 watchersCompare

[ Source](https://github.com/jelix/gandi-v5)[ Packagist](https://packagist.org/packages/jelix/gandi-v5)[ RSS](/packages/jelix-gandi-v5/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (2)Versions (11)Used By (0)

Library and command line to use the Gandi V5 API.

This library is not developed or maintained by Gandi.

Using CLI commands
==================

[](#using-cli-commands)

Requirements
------------

[](#requirements)

Minimum version of PHP is 7.2.5.

Api key
-------

[](#api-key)

To use the Gandi API, you should retrieve an API key [from your account](https://account.gandi.net/), in the security section.

You can store it into several place:

- in a file `.gandi-apikey` in the same directory of the `gandi` script
- in a file `.gandi-apikey` in your home directory
- in any file, if you set the environment variable `GANDI_APIKEY_FILE` with the full path to the file.

Usage
-----

[](#usage)

Use the `gandi` script to execute command.

```
# show global help and list all commands
./gandi

# a simple command to get the status of Gandi
./gandi status

```

Using the library in your code
==============================

[](#using-the-library-in-your-code)

You should first create a `Jelix\GandiApi\Configuration` object, with the API key:

```