Skip to content

Commit 361b5c3

Browse files
authored
Update README.md
1 parent a0e60b3 commit 361b5c3

1 file changed

Lines changed: 28 additions & 2 deletions

File tree

README.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ If you prefer, you can run the tool from the Python source instead. This option
3333

3434
## Please review this document to learn more about each tool
3535

36-
## Using CTools
36+
## 💻 Using CTools (GUI Mode)
3737

38-
When you launch **CTools**, two windows will open:
38+
When you launch **CTools** in GUI, two windows will open:
3939

4040
### 1. Main Window (GUI)
4141
- Provides an interactive graphical interface for selecting and executing tasks.
@@ -296,6 +296,32 @@ To see an explanation for what each tool does and how to use it, hover over the
296296
| **Start** | Initiates the import and update of the UI certificate. |
297297
| **Cancel** | Cancels the current operation. |
298298
299+
## 🖥️ Command Line Interface (CLI)
300+
301+
**CTools** can also be run directly from the command line. To see the available tools and options, use:
302+
303+
```cmd
304+
C:\Users\Admin\Downloads>"ctools.exe" --help
305+
306+
CTools is a GUI toolset to interact with your CTERA Environment
307+
308+
Usage: ./ctools.exe [tool] [parameters]
309+
310+
Tools:
311+
run_cmd show_status
312+
suspend_sync unsuspend_sync
313+
enable_ssh disable_ssh
314+
enable_telnet reset_password
315+
cloud_folders delete_shares
316+
copy_shares add_rem_members
317+
report_zones populate_shares
318+
add_mapping shares_report
319+
import_cert
320+
321+
For help using these tools, you can use the --help flag after selecting the tool
322+
Ex: "./ctools.exe run_cmd --help"
323+
```
324+
299325
## Adding Requests for New Features or Scripts
300326
301327
This toolset (**CTools**) is intended primarily for routine administrative tasks. If you have suggestions or feature requests related to simple administrative tasks, please either create an issue on our GitHub repository or open a support case:

0 commit comments

Comments
 (0)