gitscope
https://dev.kronoz.win/r/marzneshin.git
cli/README.md · v0.3.0-alpha6
Source
1 a47eb4c Dawsh 2y ago # CLI
2 a47eb4c Dawsh 2y ago
3 a47eb4c Dawsh 2y ago **Usage**:
4 a47eb4c Dawsh 2y ago
5 a47eb4c Dawsh 2y ago ```console
6 a47eb4c Dawsh 2y ago $ [OPTIONS] COMMAND [ARGS]...
7 a47eb4c Dawsh 2y ago ```
8 a47eb4c Dawsh 2y ago
9 a47eb4c Dawsh 2y ago **Options**:
10 a47eb4c Dawsh 2y ago
11 a47eb4c Dawsh 2y ago * `--help`: Show this message and exit.
12 a47eb4c Dawsh 2y ago
13 a47eb4c Dawsh 2y ago **Commands**:
14 a47eb4c Dawsh 2y ago
15 a47eb4c Dawsh 2y ago * `admin`
16 a47eb4c Dawsh 2y ago * `completion`: Generate and install completion scripts.
17 a47eb4c Dawsh 2y ago * `subscription`
18 a47eb4c Dawsh 2y ago * `user`
19 a47eb4c Dawsh 2y ago
20 a47eb4c Dawsh 2y ago ## `admin`
21 a47eb4c Dawsh 2y ago
22 a47eb4c Dawsh 2y ago **Usage**:
23 a47eb4c Dawsh 2y ago
24 a47eb4c Dawsh 2y ago ```console
25 a47eb4c Dawsh 2y ago $ admin [OPTIONS] COMMAND [ARGS]...
26 a47eb4c Dawsh 2y ago ```
27 a47eb4c Dawsh 2y ago
28 a47eb4c Dawsh 2y ago **Options**:
29 a47eb4c Dawsh 2y ago
30 a47eb4c Dawsh 2y ago * `--help`: Show this message and exit.
31 a47eb4c Dawsh 2y ago
32 a47eb4c Dawsh 2y ago **Commands**:
33 a47eb4c Dawsh 2y ago
34 a47eb4c Dawsh 2y ago * `create`: Creates an admin
35 a47eb4c Dawsh 2y ago * `delete`: Deletes the specified admin
36 a47eb4c Dawsh 2y ago * `import-from-env`: Imports the sudo admin from env
37 a47eb4c Dawsh 2y ago * `list`: Displays a table of admins
38 a47eb4c Dawsh 2y ago * `update`: Updates the specified admin
39 a47eb4c Dawsh 2y ago
40 a47eb4c Dawsh 2y ago ### `admin create`
41 a47eb4c Dawsh 2y ago
42 a47eb4c Dawsh 2y ago Creates an admin
43 a47eb4c Dawsh 2y ago
44 a47eb4c Dawsh 2y ago Password can also be set using the `MARZBAN_ADMIN_PASSWORD` environment variable for non-interactive usages.
45 a47eb4c Dawsh 2y ago
46 a47eb4c Dawsh 2y ago **Usage**:
47 a47eb4c Dawsh 2y ago
48 a47eb4c Dawsh 2y ago ```console
49 a47eb4c Dawsh 2y ago $ admin create [OPTIONS]
50 a47eb4c Dawsh 2y ago ```
51 a47eb4c Dawsh 2y ago
52 a47eb4c Dawsh 2y ago **Options**:
53 a47eb4c Dawsh 2y ago
54 a47eb4c Dawsh 2y ago * `-u, --username TEXT`: [required]
55 a47eb4c Dawsh 2y ago * `--sudo / --no-sudo`
56 a47eb4c Dawsh 2y ago * `--help`: Show this message and exit.
57 a47eb4c Dawsh 2y ago
58 a47eb4c Dawsh 2y ago ### `admin delete`
59 a47eb4c Dawsh 2y ago
60 a47eb4c Dawsh 2y ago Deletes the specified admin
61 a47eb4c Dawsh 2y ago
62 a47eb4c Dawsh 2y ago Confirmations can be skipped using `--yes/-y` option.
63 a47eb4c Dawsh 2y ago
64 a47eb4c Dawsh 2y ago **Usage**:
65 a47eb4c Dawsh 2y ago
66 a47eb4c Dawsh 2y ago ```console
67 a47eb4c Dawsh 2y ago $ admin delete [OPTIONS]
68 a47eb4c Dawsh 2y ago ```
69 a47eb4c Dawsh 2y ago
70 a47eb4c Dawsh 2y ago **Options**:
71 a47eb4c Dawsh 2y ago
72 a47eb4c Dawsh 2y ago * `-u, --username TEXT`: [required]
73 a47eb4c Dawsh 2y ago * `-y, --yes`: Skips confirmations
74 a47eb4c Dawsh 2y ago * `--help`: Show this message and exit.
75 a47eb4c Dawsh 2y ago
76 a47eb4c Dawsh 2y ago ### `admin import-from-env`
77 a47eb4c Dawsh 2y ago
78 a47eb4c Dawsh 2y ago Imports the sudo admin from env
79 a47eb4c Dawsh 2y ago
80 a47eb4c Dawsh 2y ago Confirmations can be skipped using `--yes/-y` option.
81 a47eb4c Dawsh 2y ago
82 a47eb4c Dawsh 2y ago What does it do?
83 a47eb4c Dawsh 2y ago - Creates a sudo admin according to `SUDO_USERNAME` and `SUDO_PASSWORD`.
84 a47eb4c Dawsh 2y ago - Links any user which doesn't have an `admin_id` to the imported sudo admin.
85 a47eb4c Dawsh 2y ago
86 a47eb4c Dawsh 2y ago **Usage**:
87 a47eb4c Dawsh 2y ago
88 a47eb4c Dawsh 2y ago ```console
89 a47eb4c Dawsh 2y ago $ admin import-from-env [OPTIONS]
90 a47eb4c Dawsh 2y ago ```
91 a47eb4c Dawsh 2y ago
92 a47eb4c Dawsh 2y ago **Options**:
93 a47eb4c Dawsh 2y ago
94 a47eb4c Dawsh 2y ago * `-y, --yes`: Skips confirmations
95 a47eb4c Dawsh 2y ago * `--help`: Show this message and exit.
96 a47eb4c Dawsh 2y ago
97 a47eb4c Dawsh 2y ago ### `admin list`
98 a47eb4c Dawsh 2y ago
99 a47eb4c Dawsh 2y ago Displays a table of admins
100 a47eb4c Dawsh 2y ago
101 a47eb4c Dawsh 2y ago **Usage**:
102 a47eb4c Dawsh 2y ago
103 a47eb4c Dawsh 2y ago ```console
104 a47eb4c Dawsh 2y ago $ admin list [OPTIONS]
105 a47eb4c Dawsh 2y ago ```
106 a47eb4c Dawsh 2y ago
107 a47eb4c Dawsh 2y ago **Options**:
108 a47eb4c Dawsh 2y ago
109 a47eb4c Dawsh 2y ago * `-o, --offset INTEGER`
110 a47eb4c Dawsh 2y ago * `-l, --limit INTEGER`
111 a47eb4c Dawsh 2y ago * `-u, --username TEXT`: Search by username
112 a47eb4c Dawsh 2y ago * `--help`: Show this message and exit.
113 a47eb4c Dawsh 2y ago
114 a47eb4c Dawsh 2y ago ### `admin update`
115 a47eb4c Dawsh 2y ago
116 a47eb4c Dawsh 2y ago Updates the specified admin
117 a47eb4c Dawsh 2y ago
118 a47eb4c Dawsh 2y ago NOTE: This command CAN NOT be used non-interactively.
119 a47eb4c Dawsh 2y ago
120 a47eb4c Dawsh 2y ago **Usage**:
121 a47eb4c Dawsh 2y ago
122 a47eb4c Dawsh 2y ago ```console
123 a47eb4c Dawsh 2y ago $ admin update [OPTIONS]
124 a47eb4c Dawsh 2y ago ```
125 a47eb4c Dawsh 2y ago
126 a47eb4c Dawsh 2y ago **Options**:
127 a47eb4c Dawsh 2y ago
128 a47eb4c Dawsh 2y ago * `-u, --username TEXT`: [required]
129 a47eb4c Dawsh 2y ago * `--help`: Show this message and exit.
130 a47eb4c Dawsh 2y ago
131 a47eb4c Dawsh 2y ago ## `completion`
132 a47eb4c Dawsh 2y ago
133 a47eb4c Dawsh 2y ago Generate and install completion scripts.
134 a47eb4c Dawsh 2y ago
135 a47eb4c Dawsh 2y ago **Usage**:
136 a47eb4c Dawsh 2y ago
137 a47eb4c Dawsh 2y ago ```console
138 a47eb4c Dawsh 2y ago $ completion [OPTIONS] COMMAND [ARGS]...
139 a47eb4c Dawsh 2y ago ```
140 a47eb4c Dawsh 2y ago
141 a47eb4c Dawsh 2y ago **Options**:
142 a47eb4c Dawsh 2y ago
143 a47eb4c Dawsh 2y ago * `--help`: Show this message and exit.
144 a47eb4c Dawsh 2y ago
145 a47eb4c Dawsh 2y ago **Commands**:
146 a47eb4c Dawsh 2y ago
147 a47eb4c Dawsh 2y ago * `install`: Install completion for the specified shell.
148 a47eb4c Dawsh 2y ago * `show`: Show completion for the specified shell,...
149 a47eb4c Dawsh 2y ago
150 a47eb4c Dawsh 2y ago ### `completion install`
151 a47eb4c Dawsh 2y ago
152 a47eb4c Dawsh 2y ago Install completion for the specified shell.
153 a47eb4c Dawsh 2y ago
154 a47eb4c Dawsh 2y ago **Usage**:
155 a47eb4c Dawsh 2y ago
156 a47eb4c Dawsh 2y ago ```console
157 a47eb4c Dawsh 2y ago $ completion install [OPTIONS] [SHELL]:[bash|zsh|fish|powershell|pwsh]
158 a47eb4c Dawsh 2y ago ```
159 a47eb4c Dawsh 2y ago
160 a47eb4c Dawsh 2y ago **Arguments**:
161 a47eb4c Dawsh 2y ago
162 a47eb4c Dawsh 2y ago * `[SHELL]:[bash|zsh|fish|powershell|pwsh]`: The shell to install completion for.
163 a47eb4c Dawsh 2y ago
164 a47eb4c Dawsh 2y ago **Options**:
165 a47eb4c Dawsh 2y ago
166 a47eb4c Dawsh 2y ago * `--help`: Show this message and exit.
167 a47eb4c Dawsh 2y ago
168 a47eb4c Dawsh 2y ago ### `completion show`
169 a47eb4c Dawsh 2y ago
170 a47eb4c Dawsh 2y ago Show completion for the specified shell, to copy or customize it.
171 a47eb4c Dawsh 2y ago
172 a47eb4c Dawsh 2y ago **Usage**:
173 a47eb4c Dawsh 2y ago
174 a47eb4c Dawsh 2y ago ```console
175 a47eb4c Dawsh 2y ago $ completion show [OPTIONS] [SHELL]:[bash|zsh|fish|powershell|pwsh]
176 a47eb4c Dawsh 2y ago ```
177 a47eb4c Dawsh 2y ago
178 a47eb4c Dawsh 2y ago **Arguments**:
179 a47eb4c Dawsh 2y ago
180 a47eb4c Dawsh 2y ago * `[SHELL]:[bash|zsh|fish|powershell|pwsh]`: The shell to install completion for.
181 a47eb4c Dawsh 2y ago
182 a47eb4c Dawsh 2y ago **Options**:
183 a47eb4c Dawsh 2y ago
184 a47eb4c Dawsh 2y ago * `--help`: Show this message and exit.
185 a47eb4c Dawsh 2y ago
186 a47eb4c Dawsh 2y ago ## `subscription`
187 a47eb4c Dawsh 2y ago
188 a47eb4c Dawsh 2y ago **Usage**:
189 a47eb4c Dawsh 2y ago
190 a47eb4c Dawsh 2y ago ```console
191 a47eb4c Dawsh 2y ago $ subscription [OPTIONS] COMMAND [ARGS]...
192 a47eb4c Dawsh 2y ago ```
193 a47eb4c Dawsh 2y ago
194 a47eb4c Dawsh 2y ago **Options**:
195 a47eb4c Dawsh 2y ago
196 a47eb4c Dawsh 2y ago * `--help`: Show this message and exit.
197 a47eb4c Dawsh 2y ago
198 a47eb4c Dawsh 2y ago **Commands**:
199 a47eb4c Dawsh 2y ago
200 a47eb4c Dawsh 2y ago * `get-config`: Generates a subscription config.
201 a47eb4c Dawsh 2y ago * `get-link`: Prints the given user's subscription link.
202 a47eb4c Dawsh 2y ago
203 a47eb4c Dawsh 2y ago ### `subscription get-config`
204 a47eb4c Dawsh 2y ago
205 a47eb4c Dawsh 2y ago Generates a subscription config.
206 a47eb4c Dawsh 2y ago
207 a47eb4c Dawsh 2y ago Generates a subscription config for the given user in the given format.
208 a47eb4c Dawsh 2y ago
209 a47eb4c Dawsh 2y ago The output will be written in the output file when the `output-file` is present,
210 a47eb4c Dawsh 2y ago otherwise will be shown in the terminal.
211 a47eb4c Dawsh 2y ago
212 a47eb4c Dawsh 2y ago **Usage**:
213 a47eb4c Dawsh 2y ago
214 a47eb4c Dawsh 2y ago ```console
215 a47eb4c Dawsh 2y ago $ subscription get-config [OPTIONS]
216 a47eb4c Dawsh 2y ago ```
217 a47eb4c Dawsh 2y ago
218 a47eb4c Dawsh 2y ago **Options**:
219 a47eb4c Dawsh 2y ago
220 a47eb4c Dawsh 2y ago * `-u, --username TEXT`: [required]
221 a47eb4c Dawsh 2y ago * `-f, --format [v2ray|clash]`: [required]
222 a47eb4c Dawsh 2y ago * `-o, --output TEXT`: Writes the generated config in the file if provided
223 a47eb4c Dawsh 2y ago * `--base64`: Encodes output in base64 format if present
224 a47eb4c Dawsh 2y ago * `--help`: Show this message and exit.
225 a47eb4c Dawsh 2y ago
226 a47eb4c Dawsh 2y ago ### `subscription get-link`
227 a47eb4c Dawsh 2y ago
228 a47eb4c Dawsh 2y ago Prints the given user's subscription link.
229 a47eb4c Dawsh 2y ago
230 a47eb4c Dawsh 2y ago NOTE: This command needs `XRAY_SUBSCRIPTION_URL_PREFIX` environment variable to be set
231 a47eb4c Dawsh 2y ago in order to work correctly.
232 a47eb4c Dawsh 2y ago
233 a47eb4c Dawsh 2y ago **Usage**:
234 a47eb4c Dawsh 2y ago
235 a47eb4c Dawsh 2y ago ```console
236 a47eb4c Dawsh 2y ago $ subscription get-link [OPTIONS]
237 a47eb4c Dawsh 2y ago ```
238 a47eb4c Dawsh 2y ago
239 a47eb4c Dawsh 2y ago **Options**:
240 a47eb4c Dawsh 2y ago
241 a47eb4c Dawsh 2y ago * `-u, --username TEXT`: [required]
242 a47eb4c Dawsh 2y ago * `--help`: Show this message and exit.
243 a47eb4c Dawsh 2y ago
244 a47eb4c Dawsh 2y ago ## `user`
245 a47eb4c Dawsh 2y ago
246 a47eb4c Dawsh 2y ago **Usage**:
247 a47eb4c Dawsh 2y ago
248 a47eb4c Dawsh 2y ago ```console
249 a47eb4c Dawsh 2y ago $ user [OPTIONS] COMMAND [ARGS]...
250 a47eb4c Dawsh 2y ago ```
251 a47eb4c Dawsh 2y ago
252 a47eb4c Dawsh 2y ago **Options**:
253 a47eb4c Dawsh 2y ago
254 a47eb4c Dawsh 2y ago * `--help`: Show this message and exit.
255 a47eb4c Dawsh 2y ago
256 a47eb4c Dawsh 2y ago **Commands**:
257 a47eb4c Dawsh 2y ago
258 a47eb4c Dawsh 2y ago * `list`: Displays a table of users
259 a47eb4c Dawsh 2y ago * `set-owner`: Transfers user's ownership
260 a47eb4c Dawsh 2y ago
261 a47eb4c Dawsh 2y ago ### `user list`
262 a47eb4c Dawsh 2y ago
263 a47eb4c Dawsh 2y ago Displays a table of users
264 a47eb4c Dawsh 2y ago
265 a47eb4c Dawsh 2y ago NOTE: Sorting is not currently available.
266 a47eb4c Dawsh 2y ago
267 a47eb4c Dawsh 2y ago **Usage**:
268 a47eb4c Dawsh 2y ago
269 a47eb4c Dawsh 2y ago ```console
270 a47eb4c Dawsh 2y ago $ user list [OPTIONS]
271 a47eb4c Dawsh 2y ago ```
272 a47eb4c Dawsh 2y ago
273 a47eb4c Dawsh 2y ago **Options**:
274 a47eb4c Dawsh 2y ago
275 a47eb4c Dawsh 2y ago * `-o, --offset INTEGER`
276 a47eb4c Dawsh 2y ago * `-l, --limit INTEGER`
277 a47eb4c Dawsh 2y ago * `-u, --username TEXT`: Search by username
278 a47eb4c Dawsh 2y ago * `--status [active|disabled|limited|expired]`
279 a47eb4c Dawsh 2y ago * `--admin, --owner TEXT`: Search by owner admin's username
280 a47eb4c Dawsh 2y ago * `--help`: Show this message and exit.
281 a47eb4c Dawsh 2y ago
282 a47eb4c Dawsh 2y ago ### `user set-owner`
283 a47eb4c Dawsh 2y ago
284 a47eb4c Dawsh 2y ago Transfers user's ownership
285 a47eb4c Dawsh 2y ago
286 a47eb4c Dawsh 2y ago NOTE: This command needs additional confirmation for users who already have an owner.
287 a47eb4c Dawsh 2y ago
288 a47eb4c Dawsh 2y ago **Usage**:
289 a47eb4c Dawsh 2y ago
290 a47eb4c Dawsh 2y ago ```console
291 a47eb4c Dawsh 2y ago $ user set-owner [OPTIONS]
292 a47eb4c Dawsh 2y ago ```
293 a47eb4c Dawsh 2y ago
294 a47eb4c Dawsh 2y ago **Options**:
295 a47eb4c Dawsh 2y ago
296 a47eb4c Dawsh 2y ago * `-u, --username TEXT`
297 a47eb4c Dawsh 2y ago * `--admin, --owner TEXT`: Admin's username
298 a47eb4c Dawsh 2y ago * `-y, --yes`: Skips confirmations
299 a47eb4c Dawsh 2y ago * `--help`: Show this message and exit.
300 a47eb4c Dawsh 2y ago