> 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-products/xygeni-shield/command-reference.md).

# Command reference

All commands are `xygeni-fw <command>`. `xygeni-fw --help` and `xygeni-fw <command> --help` list every option. On Linux, commands that change something need `sudo`; on Windows, run them from an elevated terminal.

| Command                                                           | What it does                                                                                                     |
| ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `status`                                                          | Shield's state: service, activation, seat, policy and warnings.                                                  |
| `test <ecosystem> <name> <version>`                               | Whether a package would be allowed, without downloading it.                                                      |
| `config token <token>`                                            | Set the Xygeni token (`""` removes it).                                                                          |
| `config server-url <url>` / `config malware-url <url>`            | Use an on-premises Xygeni installation (`""` restores the default).                                              |
| `config show`                                                     | The URLs in use and whether a token is set.                                                                      |
| `policy show` / `policy list`                                     | The policy in force / your local rules.                                                                          |
| `policy mode disabled\|allow-default\|deny-default`               | Black/White list mode (local policy).                                                                            |
| `policy allow\|deny add\|add-pattern\|remove\|remove-pattern ...` | Manage the Black/White list (local policy).                                                                      |
| `policy force-deny add\|remove ...`                               | Manage the minimum-age **Always deny** list (local policy).                                                      |
| `policy geo ...` / `policy registry ...`                          | Manage geo-blocking and registry control (local policy).                                                         |
| `policy edit` / `policy validate [file]`                          | Edit the local policy file / check a policy file.                                                                |
| `policy sync` / `policy status`                                   | Fetch the central policy now / state of the synchronization.                                                     |
| `alerts sync` / `alerts status`                                   | Send pending alerts now / state of the alert upload.                                                             |
| `endpoint status` / `endpoint sync-now`                           | The machine's endpoint registration in Xygeni.                                                                   |
| `isolate status`                                                  | Whether the machine is isolated.                                                                                 |
| `isolate off --code <code>`                                       | Release an isolation with a code from your security team.                                                        |
| `scan quick\|full [--dry-run]`                                    | Scan the machine for dangerous packages.                                                                         |
| `scan status\|cancel\|list\|show <id>`                            | Follow, stop and review scans.                                                                                   |
| `scan-workflow <path>`                                            | Check GitHub Actions workflows for malicious actions.                                                            |
| `fs quarantine list\|release <sha256>\|purge <sha256>`            | Manage quarantined files.                                                                                        |
| `fs test <file>`                                                  | Whether Shield would block a file.                                                                               |
| `fs status`                                                       | File protection state (Linux).                                                                                   |
| `trust sync` / `trust status`                                     | Add the Shield certificate to the Java, Node.js, pip and git trust stores.                                       |
| `bypass list` / `bypass clear [host]`                             | Programs passed through without inspection, and restoring it.                                                    |
| `malware status` / `malware sync`                                 | State of the malicious packages database / update it now.                                                        |
| `malware lookup <ecosystem> <name> [version]`                     | Look a package up in the local malicious packages database.                                                      |
| `geo lookup <ip\|host>`                                           | The country of an address and whether geo-blocking would block it.                                               |
| `cache stats` / `cache clear`                                     | Shield remembers recent decisions; clear them to re-check everything.                                            |
| `system-proxy restore`                                            | Remove proxy settings left behind after a forced shutdown.                                                       |
| `stop`                                                            | Stop the service.                                                                                                |
| `install [--token <token>] [--container-mode]`                    | Set up Shield (run by the installer; `--container-mode` for CI runners and containers).                          |
| `uninstall [--yes\|--purge]`                                      | Remove Shield (see [Uninstalling Shield](https://docs.xygeni.io/xygeni-products/xygeni-shield/uninstalling.md)). |


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.xygeni.io/xygeni-products/xygeni-shield/command-reference.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
