# discid

> A command-line tool to check a user's Discord status using Lanyard.

Latest version **1.6.2** (published 2025-06-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install discid
pnpm add discid
yarn add discid
bun add discid
```

Provides the command `discid`.

## Health

**Score 40/100 (D)** — status: stable.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 1.6.2 |
| Published | 2025-06-28 |
| First published | 2024-02-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 8 |
| Unpacked size | 16.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Inter |
| Maintainers | intter |
| Keywords | discord, status, user, presence, spotify, lanyard |

## Links

- npm: https://www.npmjs.com/package/discid
- Repository: https://github.com/inttter/discid
- Homepage: https://github.com/inttter/discid#readme
- Issues: https://github.com/inttter/discid/issues
- Funding: https://github.com/sponsors/inttter
- npm.io page: https://npm.io/package/discid

## Dependencies (8)

- [ora](https://npm.io/package/ora.md) ^8.2.0
- [open](https://npm.io/package/open.md) ^10.1.2
- [axios](https://npm.io/package/axios.md) ^1.10.0
- [chalk](https://npm.io/package/chalk.md) ^5.4.1
- [consola](https://npm.io/package/consola.md) ^3.4.2
- [commander](https://npm.io/package/commander.md) ^12.1.0
- [clipboardy](https://npm.io/package/clipboardy.md) ^4.0.0
- [cli-highlight](https://npm.io/package/cli-highlight.md) ^2.1.11

## Recent versions

- 1.6.2 (latest) — 2025-06-28
- 1.6.1 — 2024-11-30
- 1.6.0 — 2024-07-15
- 1.5.1 — 2024-05-20
- 1.5.0 — 2024-05-18
- 1.4.2 — 2024-05-11
- 1.4.1 — 2024-04-29
- 1.4.0 — 2024-03-31
- 1.3.4 — 2024-03-25
- 1.3.3 — 2024-03-18
- 1.3.2 — 2024-03-10
- 1.3.1 — 2024-03-02
- 1.3.0 — 2024-03-01
- 1.2.0 — 2024-02-29
- 1.1.0 — 2024-02-28
- … 1 more at https://npm.io/package/discid/versions

## README

<div align="center">
  <img src="https://github.com/inttter/discid/assets/73017070/c37fde61-3d46-4b9f-9ce5-b0bbe1f54e0d" width="450">

[![Downloads](https://img.shields.io/npm/dw/discid.svg?style=flat&colorA=black&colorB=5865F2)](https://npmjs.org/package/discid)
[![Version](https://img.shields.io/npm/v/discid.svg?style=flat&colorA=black&colorB=5865F2)](https://www.npmjs.com/package/discid)
[![License](https://shields.io/github/license/inttter/discid?labelColor=black&colorB=5865F2)](https://github.com/inttter/discid/blob/master/LICENSE/)
[![Post](https://img.shields.io/badge/read-post-f39f37?labelColor=black&colorB=5865F2)](https://iinter.me/writing/using-discid)

A simple command-line tool to check a user's Discord status using [Lanyard](https://github.com/Phineas/lanyard) and get an output in a readable format.

<div align="center">
  <img src="https://github.com/user-attachments/assets/cb8196a5-2ffe-4c3d-83e2-5b110cb96d0b" width="750" alt="Example of running command">
</div>

</div>

# Installation

To run `discid` on your machine, install it using npm:

```bash
npm install -g discid
```

# Usage

> [!IMPORTANT]
> The user must be in the [Lanyard Discord server](https://discord.com/invite/lanyard) in order to retrieve information about them.

```bash
discid [userID]
```

You will need to replace `[userID]` with the ID of the user you are trying to fetch the status of. To find the ID of a user, you can follow a [guide with images](https://iinter.me/writing/using-discid#how-do-you-find-a-user-id), or you can follow the steps below:

1. Enable Developer Mode by going to **Settings** ➔ **Advanced** ➔ **Developer Mode**, and check the toggle to be on.

2.  Right click on a user and click the [`Copy User ID`](https://iinter.me/images/using-discid/copy-user-id.png) button.

3. Go back to your command line and run the same command from above, replacing `[userID]` with the ID you copied.

For example, to check the status of the user `iinter`, you can run the following command:

```bash
discid 514106760299151372
```

Depending on what the user is doing, you may get different outputs. Here is an example of what might be returned:

```bash
lunar (iinter) • 🟢 Online (Desktop)
Listening To: Never More by Shihoko Hirata • 3min 42sec left
Avatar URL: https://api.lanyard.rest/514106760299151372.png
```

To see everything that can be displayed and for slightly more information, see [this page](https://iinter.me/writing/using-discid#what-else).

# Options

| Option  | Description |
| ----------- | ----------- |
| `--json` | Shows a formatted, syntax-highlighted JSON response of information about the user from `https://api.lanyard.rest/v1/users/:user_id`, replacing `:user_id` with the user ID you entered. |
| `--visit`, `--open` | Opens the user's profile on the Discord website (in your browser). **This works with any user on Discord.** |
| `--kv` | Displays the user's Lanyard key-value (KV) pairs (see [here](https://github.com/Phineas/lanyard?tab=readme-ov-file#kv) for more information). |

---

# License

© **2025** - Licensed under the [MIT License](https://github.com/inttter/discid/blob/master/LICENSE).

---
_Source: https://npm.io/package/discid · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
