> For the complete documentation index, see [llms.txt](https://docs.currents.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.currents.dev/resources/reporters/currents-cmd/currents-skill.md).

# currents skill

Install the currents-cli agent skill, which tells coding agents such as Claude Code, Codex and Cursor how to use the currents command

`currents skill` prints or installs the `currents-cli` agent skill. The skill tells a coding agent which `currents` command fits a task, which key each command needs, and how to add the commands to GitHub Actions and GitLab CI. Its content matches the version of `@currents/cmd` that prints it.

## Install the skill in a project

```bash
npx --package @currents/cmd@2 currents skill --install
```

The command writes the skill folder to `.agents/skills/currents-cli`. Agents read project skills from these folders:

| Agent         | Folder           |
| ------------- | ---------------- |
| Codex, Cursor | `.agents/skills` |
| Claude Code   | `.claude/skills` |

For Claude Code, install the skill to `.claude/skills`:

```bash
npx --package @currents/cmd@2 currents skill --install --dir .claude/skills
```

Commit the skill folder so that every agent working in the repository reads it.

## What the skill contains

* `SKILL.md`: which command to use for a task, the keys and environment variables of each command, exit codes, and safety rules, such as never printing a key
* `references/ci-setup.md`: GitHub Actions and GitLab CI steps for `run upload`, `run attach`, `run cancel` and rerunning failed tests with `cache`
* `references/sessions.md`: how to record a session, attach files to it and share it

`npx --package @currents/cmd@2 currents skill` without options prints `SKILL.md` only. Install the skill to get the reference files too.

## Options

| Option         | Description                                                            |
| -------------- | ---------------------------------------------------------------------- |
| `--install`    | Write the skill folder to `<dir>/currents-cli`.                        |
| `--dir <path>` | The skills folder to install to. Default: `.agents/skills`.            |
| `--force`      | Replace an installed copy of the skill that differs from this version. |

Without `--force`, `--install` fails when an installed copy differs from this version, and leaves it in place. After you upgrade `@currents/cmd`, run `npx --package @currents/cmd@2 currents skill --install --force` to update the skill.


---

# 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.currents.dev/resources/reporters/currents-cmd/currents-skill.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.