README.md

discid

A simple command-line tool to check a user's Discord status using Lanyard, and get an output in a readable format.

Installation

npm install -g discid

Usage

Important

The user must be in the Lanyard Discord server in order to retrieve information about them.

discid [userID]

You will need to replace [userID] with the ID of the user you are trying to fetch the status of. If you want an guide with images, visit this page, otherwise, you can follow these steps.

1. Enable Developer mode by going to Settings ➔ Advanced ➔ Developer Mode, and check the toggle.

2. Right click on a user and click the Copy User ID 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:

discid 514106760299151372

Depending on what the user is doing, the otuput might return different things. Here is an example of what may be retuned:

iinter (lunar) • 🟢 Online
Listening To: Duvet by bôa on Twilight
Platform: Desktop
Avatar URL: https://cdn.discordapp.com/avatars/514106760299151372/d14e90a16144987f53f5a3700aacc934.png

These are returned because the status of the user is set to 'Online' and they are listening to the song 'Duvet' by 'bôa' at the time the command was ran.

To see everything that can be displayed and more detailed information, see this page.

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	Output's the user's Lanyard key-value (KV) pairs (see here for more information).

---

License

©️ 2024 - Licensed under the MIT License.