Skip to content

Commit d5356ea

Browse files
docs: populate commands explanation doc
1 parent 6c8913c commit d5356ea

File tree

1 file changed

+85
-0
lines changed

1 file changed

+85
-0
lines changed

docs/src/user-guide/commands.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,86 @@
11
# Commands
2+
3+
GitCord has commands for managing your Discord server. You can use `!` commands or `/` slash commands.
4+
5+
## Basic Commands
6+
7+
### `!hello`
8+
Say hello to the bot.
9+
10+
**Usage:** `!hello`
11+
12+
**Permissions:** None needed
13+
14+
### `!ping` / `/slashping`
15+
Check if the bot is working.
16+
17+
**Usage:**
18+
- `!ping`
19+
- `/slashping`
20+
21+
**Permissions:** None needed
22+
23+
## Channel Commands
24+
25+
### `!createchannel`
26+
Create one channel from a YAML file.
27+
28+
**Usage:** `!createchannel`
29+
30+
**Permissions:** Manage Channels
31+
32+
**Note:** Uses a fixed file path, This will be changed with the release of 1.X: `/home/user/Projects/gitcord-template/community/off-topic.yaml`
33+
34+
### `!createcategory` / `/createcategory`
35+
Create a category with multiple channels.
36+
37+
**Usage:**
38+
- `!createcategory`
39+
- `/createcategory [yaml_path]`
40+
41+
**Permissions:** Manage Channels
42+
43+
**Note:** `!createcategory` uses a fixed path by default, This will be changed with the release of 1.X. `/createcategory` lets you specify a path.
44+
45+
## Admin Commands
46+
47+
### `!fetchurl` / `/fetchurl`
48+
Get text from a website.
49+
50+
**Usage:**
51+
- `!fetchurl <url>`
52+
- `/fetchurl <url>`
53+
54+
**Permissions:** Administrator
55+
56+
### `!synccommands` / `/synccommands`
57+
Update slash commands.
58+
59+
**Usage:**
60+
- `!synccommands`
61+
- `/synccommands`
62+
63+
**Permissions:** Administrator
64+
65+
## Help Commands
66+
67+
### `!help` / `/help`
68+
Show help and links.
69+
70+
**Usage:**
71+
- `!help`
72+
- `/help`
73+
74+
**Permissions:** None needed
75+
76+
## Permissions
77+
78+
- **None needed:** Anyone can use
79+
- **Manage Channels:** Can create/edit channels
80+
- **Administrator:** Can use admin commands
81+
82+
## Common Errors
83+
84+
- **"Command not found"**: Check spelling or sync commands
85+
- **"Permission denied"**: You need the right permissions
86+
- **"File not found"**: Check your YAML file path

0 commit comments

Comments
 (0)