> For the complete documentation index, see [llms.txt](https://docs.interlynk.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.interlynk.io/lynkctl/installation.md).

# Installation

## Obtaining lynkctl

lynkctl is distributed directly by Interlynk. Contact Interlynk to receive the binary for your operating system and CPU architecture. Once you have it, place it on your `PATH` — for example, in `/usr/local/bin`.

## Requirements

lynkctl is a self-contained binary. It needs additional tooling only when analysing certain build systems:

| When analysing                                                                         | You also need                                                                                                                    |
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| GNU Make projects                                                                      | GNU Make 3.81 or newer, on `PATH`                                                                                                |
| CMake projects                                                                         | CMake 3.14 or newer, and a build tree that has already been configured so that CMake File API replies exist                      |
| IAR Embedded Workbench projects                                                        | No extra tooling                                                                                                                 |
| Package manifest projects (npm, Python, Go, Maven, Gradle, Cargo, RubyGems, PHP, .NET) | No extra tooling — lynkctl reads the manifests and lockfiles directly. The package manager itself does not need to be installed. |

No compiler or target toolchain is required. lynkctl reads build definitions and manifests; it does not build the project.

## Verify the Installation

```bash
lynkctl version
```

This prints the build version of lynkctl.

## The OSS-Index Database

To identify vendored open-source code, lynkctl uses a local OSS-index database. Download it before your first `generate` run:

```bash
lynkctl db download
```

The download is roughly 300 MB. See [OSS-Index Database](/lynkctl/database.md) for cache locations, refreshing, and air-gapped use.

{% hint style="info" %}
If you do not need vendored open-source identification, you can skip the database and pass `--no-oss-index` to `generate`.
{% 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:

```
GET https://docs.interlynk.io/lynkctl/installation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.