> For the complete documentation index, see [llms.txt](https://docs.xygeni.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xygeni.io/xygeni-scanner-cli/xygeni-cli-overview/xygeni-cli-authentication/cli-authentication-with-xygeni.md).

# CLI Authentication with Xygeni

The scanner needs an Xygeni API token to reach the platform.

{% hint style="info" %}
The shipped `conf/xygeni.yml` reads the token from the environment, as `apikey: ${XYGENI_TOKEN}`. Export `XYGENI_TOKEN` before running the CLI and there is nothing further to configure:

```bash
export XYGENI_TOKEN=<your token>
```

For a self-hosted platform, export `XYGENI_URL` as well — the same file resolves `url: ${XYGENI_URL:-https://api.xygeni.io}`.

If you prefer not to use environment variables, pass the token on the command line with `--token`, as shown below, or store it in a file and reference it from `conf/xygeni.yml` as `file:~/path/xygeni.token`.
{% endhint %}

To authenticate through the Xygeni Scanner CLI you may use the following options:

```
 xygeni [-hqvV]
  [--user=<username>] [--pass=<password>] [--token=<token>] [--url=<url>]
  COMMAND [@<args_file>] [<command options>]
  
Xygeni credentials - clear-text or encrypted, env:VAR, file:PATH
They override the corresponding values in xygeni.yml configuration.
      --url=<url>         Xygeni api URL
      --token=<token>     Access token.
      --user=<username>   Username.
      --pass=<password>   Password. Deprecated, token is recommended.
```

{% hint style="info" %}
See [Generate Token for Scanner and API client](/xygeni-administration/platform-administration/profile.md#generate_token_for_scanner-1) for further information on how to create Xygeni tokens.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.xygeni.io/xygeni-scanner-cli/xygeni-cli-overview/xygeni-cli-authentication/cli-authentication-with-xygeni.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.