Archive/DiscordChatExporter
1
0
Fork 0
mirror of https://github.com/Tyrrrz/DiscordChatExporter.git synced 2026-04-04 03:23:05 -06:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Rename 'list guilds' to 'list servers'; use 'servers' in all user-facing text; simplify token setup in docs

Browse source 
Agent-Logs-Url: https://github.com/Tyrrrz/DiscordChatExporter/sessions/688f7e3c-af04-410d-93e7-18d7c0620672

Co-authored-by: Tyrrrz <1935960+Tyrrrz@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot] 2026-04-04 09:10:11 +00:00 committed by GitHub
parent 245b368396
commit 4ec8faef93
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 40 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
.docs/Using-the-CLI.md
View file

@ -38,11 +38,33 @@ Type the following command in your terminal of choice, then press ENTER to run i
| export | Exports one or more channels | | export | Exports one or more channels |
| list channels | Outputs the list of channels in the given server(s) | | list channels | Outputs the list of channels in the given server(s) |
| list channels dm | Outputs the list of direct message channels | | list channels dm | Outputs the list of direct message channels |
| list guilds | Outputs the list of accessible servers | | list servers | Outputs the list of accessible servers |
| guide | Explains how to obtain token, server, and channel ID | | guide | Explains how to obtain token, server, and channel ID |
To use the commands, you'll need a token. For the instructions on how to get a token, please refer to [this page](Token-and-IDs.md), or run `./dce guide`. To use the commands, you'll need a token. For the instructions on how to get a token, please refer to [this page](Token-and-IDs.md), or run `./dce guide`.
To pass the token, use the `-t` option:
```console
./dce export 53555 -t "mfa.Ifrn"
```
Alternatively, you can set the `DISCORD_TOKEN` environment variable and omit `-t`:
**Linux/macOS:**
```console
export DISCORD_TOKEN="mfa.Ifrn"
```
**Windows:**
```console
set DISCORD_TOKEN=mfa.Ifrn
```
The pipeline examples in this guide assume `DISCORD_TOKEN` is already set.
To get help with a specific command, run: To get help with a specific command, run:
```console ```console
@ -224,23 +246,22 @@ Documentation on message filter syntax can be found [here](https://github.com/Ty
To export all channels in a specific server, use `list channels` to list channels and pipe the result to `export`. To export all channels in a specific server, use `list channels` to list channels and pipe the result to `export`.
**Linux/macOS** (one-liner, token set inline): **Linux/macOS:**
```console ```console
DISCORD_TOKEN="mfa.Ifrn" ./dce list channels 21814 | ./dce export ./dce list channels 21814 | ./dce export
``` ```
**Windows**: **Windows:**
```console ```console
set DISCORD_TOKEN=mfa.Ifrn
dce list channels 21814 | dce export dce list channels 21814 | dce export
``` ```
You can also list channels for multiple guilds at once: You can also list channels for multiple servers at once:
```console ```console
DISCORD_TOKEN="mfa.Ifrn" ./dce list channels 21814 35930 | ./dce export ./dce list channels 21814 35930 | ./dce export
``` ```
#### Including threads #### Including threads
@ -248,7 +269,7 @@ DISCORD_TOKEN="mfa.Ifrn" ./dce list channels 21814 35930 | ./dce export
By default, threads are not included. You can change this behavior by passing `--include-threads` to the `list channels` command. It has possible values of `none`, `active`, or `all`, indicating which threads should be included. To include both active and archived threads, use `--include-threads all`. By default, threads are not included. You can change this behavior by passing `--include-threads` to the `list channels` command. It has possible values of `none`, `active`, or `all`, indicating which threads should be included. To include both active and archived threads, use `--include-threads all`.
```console ```console
DISCORD_TOKEN="mfa.Ifrn" ./dce list channels 21814 --include-threads all | ./dce export ./dce list channels 21814 --include-threads all | ./dce export
``` ```
#### Including voice channels #### Including voice channels
@ -256,23 +277,22 @@ DISCORD_TOKEN="mfa.Ifrn" ./dce list channels 21814 --include-threads all | ./dce
By default, voice channels are included. You can change this behavior by passing `--include-vc false` to the `list channels` command. By default, voice channels are included. You can change this behavior by passing `--include-vc false` to the `list channels` command.
```console ```console
DISCORD_TOKEN="mfa.Ifrn" ./dce list channels 21814 --include-vc false | ./dce export ./dce list channels 21814 --include-vc false | ./dce export
``` ```
### Export all DMs ### Export all DMs
To export all DMs: To export all DMs:
**Linux/macOS**: **Linux/macOS:**
```console ```console
DISCORD_TOKEN="mfa.Ifrn" ./dce list channels dm | ./dce export ./dce list channels dm | ./dce export
``` ```
**Windows**: **Windows:**
```console ```console
set DISCORD_TOKEN=mfa.Ifrn
dce list channels dm | dce export dce list channels dm | dce export
``` ```
@ -287,7 +307,7 @@ To list the channels available in a specific server, use the `list channels` com
When the output is redirected or piped, the `list channels` command prints only channel IDs (one per line). This allows you to pipe the output directly to the `export` command: When the output is redirected or piped, the `list channels` command prints only channel IDs (one per line). This allows you to pipe the output directly to the `export` command:
```console ```console
DISCORD_TOKEN="mfa.Ifrn" ./dce list channels 21814 | ./dce export ./dce list channels 21814 | ./dce export
``` ```
### List direct message channels ### List direct message channels
@ -301,13 +321,13 @@ To list all DM channels accessible to the current account, use the `list channel
When the output is redirected or piped, the `list channels dm` command prints only channel IDs (one per line). This allows you to pipe the output directly to the `export` command: When the output is redirected or piped, the `list channels dm` command prints only channel IDs (one per line). This allows you to pipe the output directly to the `export` command:
```console ```console
DISCORD_TOKEN="mfa.Ifrn" ./dce list channels dm | ./dce export ./dce list channels dm | ./dce export
``` ```
### List servers ### List servers
To list all servers accessible by the current account, use the `list guilds` command: To list all servers accessible by the current account, use the `list servers` command:
```console ```console
./dce list guilds -t "mfa.Ifrn" > C:\path\to\output.txt ./dce list servers -t "mfa.Ifrn" > C:\path\to\output.txt
``` ```

4
DiscordChatExporter.Cli/Commands/GetChannelsCommand.cs
View file

@ -16,7 +16,7 @@ namespace DiscordChatExporter.Cli.Commands;
[Command("list channels", Description = "Gets the list of channels in one or more servers.")] [Command("list channels", Description = "Gets the list of channels in one or more servers.")]
public partial class GetChannelsCommand : DiscordCommandBase public partial class GetChannelsCommand : DiscordCommandBase
{ {
[CommandParameter(0, Name = "guild-ids", Description = "Server ID(s).")] [CommandParameter(0, Name = "server-ids", Description = "Server ID(s).")]
public required IReadOnlyList<Snowflake> GuildIds { get; set; } public required IReadOnlyList<Snowflake> GuildIds { get; set; }
[CommandOption("include-vc", Description = "Include voice channels.")] [CommandOption("include-vc", Description = "Include voice channels.")]
@ -71,7 +71,7 @@ public partial class GetChannelsCommand : DiscordCommandBase
} }
else else
{ {
// Show guild header when listing multiple guilds // Show server header when listing multiple servers
if (GuildIds.Count > 1) if (GuildIds.Count > 1)
{ {
var guild = await Discord.GetGuildAsync(guildId, cancellationToken); var guild = await Discord.GetGuildAsync(guildId, cancellationToken);

2
DiscordChatExporter.Cli/Commands/GetGuildsCommand.cs
View file

@ -9,7 +9,7 @@ using DiscordChatExporter.Core.Utils.Extensions;
namespace DiscordChatExporter.Cli.Commands; namespace DiscordChatExporter.Cli.Commands;
[Command("list guilds", Description = "Gets the list of accessible servers.")] [Command("list servers", Description = "Gets the list of accessible servers.")]
public partial class GetGuildsCommand : DiscordCommandBase public partial class GetGuildsCommand : DiscordCommandBase
{ {
public override async ValueTask ExecuteAsync(IConsole console) public override async ValueTask ExecuteAsync(IConsole console)