> For the complete documentation index, see [llms.txt](https://rc.sunbird.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://rc.sunbird.org/use/getting-started/installation/registry-cli.md).

# Registry CLI

{% hint style="info" %}
**System requirements**: 4 cores · 8 GB RAM · 100 GB disk minimum.
{% endhint %}

This guide assumes some familiarity with basic Linux commands. Don't copy-paste the `$` signs — they indicate that what follows is a terminal command.

{% stepper %}
{% step %}

### Install the Registry CLI

```bash
$ npm install --global @sunbird-rc/registry-cli
```

If you hit a permission-denied error, prefix the command with `sudo`:

```bash
$ sudo npm install --global @sunbird-rc/registry-cli
```

Check the install:

```bash
$ registry help
```

{% endstep %}

{% step %}

### Set up a registry instance

Run the following in a directory where you wish to set up the registry (`~/Registries/example/` in this example):

```bash
$ mkdir -p ~/Registries/example
$ cd ~/Registries/example
$ registry init
```

This presents a set of questions to configure the registry — registry version, auxiliary services (toggle with SPACE BAR), and the QR code type to generate on certificates when signing is enabled. You can accept the defaults for a first run.
{% endstep %}

{% step %}

### Check the registry status

```bash
$ registry status
```

Confirm every service shows as running. If a service shows `exited`, restart just that service:

```bash
$ docker-compose restart <service-name>
```

To force-recreate the registry service after a config or schema change:

```bash
$ SCHEMA_DIR=config/schemas docker-compose up -d --force-recreate --no-deps registry
```

{% endstep %}

{% step %}

### Stop the registry

```bash
$ registry down
```

{% endstep %}
{% endstepper %}


---

# 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://rc.sunbird.org/use/getting-started/installation/registry-cli.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.