dokdo - GitLite

KO | EN

gitlite — search

#javascript #python #react #ai #llm #go #linux #nodejs #windows #awesome #awesome-list #security #mcp #open-source

dokdo

(★ 64)

Dokdo. Easy Discord bot debuging tool.

File Explorer

Download Latest Version (.zip)

- - bug-report.yml
  - config.yml
  - feature-request.yml
- - npm-publish-nightly.yml
  - npm-publish.yml
  - testing.yml
- CONTRIBUTING.md
- PULL_REQUEST_TEMPLATE.md
- - yarn-3.2.4.cjs
- cat.png
- curl.png
- dokdo.png
- js.png
- jsi.png
- logo.png
- main.png
- pagination.png
- sh.gif
- shard.png
- token.png
- bot-esm.js
- bot.js
- config.example.js
- shard.js
- - cat.ts
  - curl.ts
  - exec.ts
  - index.ts
  - js.ts
  - jsi.ts
  - main.ts
  - shard.ts
- - codeBlock.ts
  - count.ts
  - DateFormatting.ts
  - hljs.ts
  - index.ts
  - inspect.ts
  - isGenerator.ts
  - isinstance.ts
  - join.ts
  - KillChildrenProcess.ps1
  - ProcessManager.ts
  - regexpEscape.ts
  - system.ts
  - table.ts
  - type.ts
- index.ts
- Utils.codeBlock.test.js
- Utils.count.test.js
- Utils.hljs.test.js
- Utils.ProcessManager.test.js
.gitattributes
.gitignore
.yarnrc.yml
eslint.config.js
LICENSE
package.json
README.md
tsconfig.json
tsup.config.ts
yarn.lock

# Installation Guide

1. Get the code

git clone https://github.com/wonderlandpark/dokdo

Downloads the entire project code from GitHub to your computer.

cd dokdo

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install dokdo

Downloads and installs the libraries listed in package.json.

npm i dokdo@djsv12

Type this command into your terminal and run it.

npm i dokdo@djsv13

Type this command into your terminal and run it.

npm i @wonderlandpark/dokdo@nightly

Type this command into your terminal and run it.

<a href="https://npmjs.com/package/dokdo"><img src="https://img.shields.io/npm/v/dokdo"></a>

Type this command into your terminal and run it.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">
<img src="assets/dokdo.png">
<br/>
<p>
    <a href="https://npmjs.com/package/dokdo"><img src="https://img.shields.io/npm/v/dokdo"></a>
    <a href="https://github.com/wonderlandpark/dokdo/actions"><img src="https://github.com/wonderlandpark/dokdo/workflows/Testing/badge.svg" alt="Build status" /></a>
</p>
<p>
    <a href="https://nodei.co/npm/dokdo/"><img src="https://nodei.co/npm/dokdo.png"></a>
</p>
</div>

# Dokdo

**Dokdo** is a powerful, extensible debugging toolkit for `discord.js`.
It allows you to evaluate JavaScript code, run shell commands, and inspect your bot in real-time directly from Discord.

> Inspired by [Jishaku](https://github.com/scarletcafe/jishaku) for `discord.py`.

## ✨ Features

- **Eval Command** – Run JavaScript code directly in the context of your bot.
![js](https://raw.githubusercontent.com/wonderlandpark/dokdo/main/assets/js.png)
![jsi](https://raw.githubusercontent.com/wonderlandpark/dokdo/main/assets/jsi.png)

- **Shell Command** – Execute terminal commands through Discord. You could also abort running process.
![sh](https://raw.githubusercontent.com/wonderlandpark/dokdo/main/assets/sh.gif)

- **Paginated Output** – Long outputs are automatically split and navigable via or buttons.
![pagination](https://raw.githubusercontent.com/wonderlandpark/dokdo/main/assets/pagination.png)

- **Security Protection** – Automatically masks bot tokens and other sensitive values from outputs.
![token](https://raw.githubusercontent.com/wonderlandpark/dokdo/main/assets/token.png)

- **Easy to Customize** – Tailor prefixes, aliases, owners, variables, and permission error messages etc to fit your needs.

## 🚀 Installation

Dokdo stable version requires Discord.js v14 or later.

```bash
npm install dokdo
```

<details>
    <summary>Using Discord.js v12?</summary>

You could install `dokdo@0.4.1` by
    
```sh
  npm i dokdo@djsv12
```
</details>

<details>
    <summary>Using Discord.js v13?</summary>

You could install `dokdo@0.5.1` by
    
```sh
  npm i dokdo@djsv13
```
</details>

<details>
  <summary>Nightly Version?</summary>

[Github Packages](https://github.com/wonderlandpark/dokdo/pkgs/npm/dokdo)
(registry configuration needed)

```sh
npm i @wonderlandpark/dokdo@nightly
```
</details>

## 🛠️ Usage

```js
const Discord = require('discord.js')
const client = new Discord.Client({ intents: ['GUILDS', 'GUILD_MESSAGES'] })

const Dokdo = require('dokdo')

const DokdoHandler = new Dokdo.Client(client, { aliases: ['dokdo', 'dok'], prefix: '!' }) // Using Bot Application ownerID as default for owner option.

client.on('messageCreate', async message => {
  if (message.content === 'ping') return message.channel.send('Pong') // handle commands first
  await DokdoHandler.run(message) // try !dokdo
})

client.login('super secret token')
```

## 📦 Command References

### `> dokdo [js|javascript] <argument>`
### `> dokdo [jsi|javascript_inspect] <argument>`
Evaluate or execute JavaScript(Node.js) code passed.

Available Variables by default:

| VARIABLE  | DESCRIPTION |
|---|---|
| `client` | The bot `client(Discord.Client)` passed by `Dokdo.Client(client)` |
| `message` | The `message(Discord.Message)` passed by `DokdoHandler.run(message)` |
| `_dokdo` | The Dokdo Client |

### `> dokdo [exec||shell|sh|bash|ps|powershell|zsh] <argument>`

Executes commands at your system shell.

Dokdo detects your `SHELL` environment variable(process.env.SHELL) or uses powershell for Windows platform. You could abort running process by a Button.

The execution terminates automatically after 3 minutes.

### `> dokdo [cat] <argument>`

Reads a file from your file system. Pass your file path. (Ex: /home/dokdo/bot.js)

### `> dokdo [curl] <argument>`

Reads text of given URL.

### `> dokdo [shard] <argument>`

Executes commands on every sharded processes. (Discord.js Sharding)

## 🧾 Notes

### Message contents intent not approved?

You can set the Dokdo prefix including mentions. This allows the client to read the message content.

Example:

```js
new Dokdo.Client(client, {  prefix: '<@285185716240252929>' })
```
Command Usage: `<@285185716240252929>dokdo`

## 📚 Documentation

Full documentation, examples, and advanced usage:

👉 https://dokdo.js.org

## 🤝 Contributing

Pull requests and issues are welcome. Dokdo is open-source and built with developer experience in mind. Please check [the contribution guide](./.github/CONTRIBUTING.md) before you submit Pull Request.