> 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.md).

# Xygeni Shield

### Overview

**Xygeni Shield** is a lightweight agent that protects developer workstations, servers and CI runners from malicious open-source packages. It checks every package your tools download from public registries and blocks the dangerous ones **before they reach the machine**.

Shield works in the background. You keep using `npm`, `pip`, `mvn`, `gradle`, `cargo`, `go`, `dotnet`, `gem`, `composer` and your IDE marketplaces exactly as before: there is nothing to configure in them. When a package is allowed, nothing changes. When it is blocked, the tool fails with a clear message that tells you which package was stopped and why.

### How Shield decides what to block

Every download is checked against three independent signals:

* **Xygeni malware intelligence**: a local copy of the Xygeni malicious packages database, kept up to date automatically. Known-malicious packages are blocked without any setup.
* **Your organization's rules**: allow and deny lists (Black/White list) defined by your security team in the Xygeni dashboard, or locally on machines that are not centrally managed.
* **Minimum-age policy**: optionally, packages published too recently (for example, in the last 7 days) are blocked. This catches new supply-chain attacks before they have been reported.

On top of that, Shield can:

* block traffic to specific countries (**geo-blocking**),
* restrict which registries packages may be downloaded from (**registry control**),
* block connections to known-malicious IP addresses and domains,
* inspect package files written to disk and **quarantine** the dangerous ones, and scan the machine for packages that were already there,
* **isolate** a compromised machine from the network at the request of your security team.

### Supported ecosystems

npm (also yarn and pnpm), PyPI (pip, poetry, uv), Maven and Gradle, NuGet, RubyGems, Cargo, Go modules, Composer, GitHub Actions, VS Code and Open VSX extensions, Visual Studio extensions, JetBrains plugins and the Eclipse Marketplace.

### Supported platforms

Debian / Ubuntu Linux and Windows 10 / 11. See [System requirements](https://docs.xygeni.io/xygeni-products/xygeni-shield/requirements.md).

### Getting started

1. Check the [System requirements](https://docs.xygeni.io/xygeni-products/xygeni-shield/requirements.md).
2. [Install Shield](https://docs.xygeni.io/xygeni-products/xygeni-shield/installing.md) on the machine.
3. [Activate it with your Xygeni token](https://docs.xygeni.io/xygeni-products/xygeni-shield/activating.md). Shield does not protect the machine until it is activated.

For more information regarding Xygeni Shield, refer to these sections:

* [System requirements](https://docs.xygeni.io/xygeni-products/xygeni-shield/requirements.md)
* [Installing Shield](https://docs.xygeni.io/xygeni-products/xygeni-shield/installing.md)
* [Activating Shield](https://docs.xygeni.io/xygeni-products/xygeni-shield/activating.md)
* [Using Shield day to day](https://docs.xygeni.io/xygeni-products/xygeni-shield/everyday-use.md)
* [Protection policy](https://docs.xygeni.io/xygeni-products/xygeni-shield/protection-policy.md)
* [Geo-blocking and registry control](https://docs.xygeni.io/xygeni-products/xygeni-shield/network-controls.md)
* [File protection and scans](https://docs.xygeni.io/xygeni-products/xygeni-shield/files-and-scans.md)
* [Managing Shield from the dashboard](https://docs.xygeni.io/xygeni-products/xygeni-shield/dashboard.md)
* [Network isolation](https://docs.xygeni.io/xygeni-products/xygeni-shield/network-isolation.md)
* [Agent settings](https://docs.xygeni.io/xygeni-products/xygeni-shield/agent-settings.md)
* [Uninstalling Shield](https://docs.xygeni.io/xygeni-products/xygeni-shield/uninstalling.md)
* [Troubleshooting](https://docs.xygeni.io/xygeni-products/xygeni-shield/troubleshooting.md)
* [Command reference](https://docs.xygeni.io/xygeni-products/xygeni-shield/command-reference.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.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.
