Skip to content
This repository was archived by the owner on Oct 23, 2024. It is now read-only.

Commit 2fd5ea4

Browse files
update readme usage for new argparse version
1 parent ecf1b5f commit 2fd5ea4

File tree

1 file changed

+77
-29
lines changed

1 file changed

+77
-29
lines changed

README.md

Lines changed: 77 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -68,35 +68,83 @@ MaxBedTemp = 85
6868

6969
## Usage
7070

71-
octoprint-cli
72-
===============================================================================
73-
command line tool to control octoprint servers
74-
75-
COMMANDS
76-
octoprint-cli help view this help message
77-
octoprint-cli print status view job status
78-
octoprint-cli print select [file] load file
79-
octoprint-cli print start start print
80-
octoprint-cli print pause pause print
81-
octoprint-cli print resume resume print
82-
octoprint-cli print cancel cancel print
83-
octoprint-cli connection status view connection status
84-
octoprint-cli connection connect connect to printer with autodetection
85-
octoprint-cli connection disconnect disconnect from printer
86-
octoprint-cli temp status view printer temperature status
87-
octoprint-cli temp extruder [target] set extruder target temperature
88-
octoprint-cli temp bed [target] set bed target temperature
89-
octoprint-cli files list list files and folders in root dir
90-
octoprint-cli files list [dir] list files in directory
91-
octoprint-cli files info [name] get information on file or folder
92-
octoprint-cli files upload [file] upload file to OctoPrint server storage
93-
octoprint-cli system restart restart OctoPrint server
94-
octoprint-cli system restart-safe restart OctoPrint server to safe mode
95-
octoprint-cli system reboot reboot server
96-
octoprint-cli system shutdown shutdown server
97-
octoprint-cli continuous get refreshing continuous status
98-
octoprint-cli gcode "[command]" run gcode on printer
99-
octoprint-cli layers view DisplayLayerProgress information
71+
<details>
72+
<summary><b>General Commands</b></summary><br>
73+
74+
`octoprint-cli version` - get OctoPrint server version information
75+
76+
`octoprint-cli continuous` - get continuous refreshing temperature, layer, and print status
77+
78+
</details>
79+
80+
<details>
81+
<summary><b>Print Commands</b></summary><br>
82+
83+
`octoprint-cli print status` - get current print job status
84+
85+
`octoprint-cli print select [path]` - load file on server
86+
87+
`octoprint-cli print start` - start print job on loaded file
88+
89+
`octoprint-cli print cancel` - cancel current print job
90+
91+
`octoprint-cli print pause` - pauses the current print job
92+
93+
`octoprint-cli print resume` - resumes the current print job
94+
95+
`octoprint-cli gcode [command]` - run GCODE command on printer
96+
97+
`octoprint-cli layers` - get layer information during prints from the DisplayLayerProgress plugin
98+
99+
</details>
100+
101+
<details>
102+
<summary><b>Connection Commands</b></summary><br>
103+
104+
`octoprint-cli connection status` - get OctoPrint print connection information
105+
106+
`octoprint-cli connection connect` - connect to printer, serial port and baudrate are decided automatically unless specified with the `-b [BAUDRATE]` and `-p [PORT]` flags
107+
108+
`octoprint-cli connection disconnect` - disconnect from printer
109+
110+
</details>
111+
112+
<details>
113+
<summary><b>Temperature Commands</b></summary><br>
114+
115+
`octoprint-cli temp status` - get current and target temperatures of extruder and bed
116+
117+
`octoprint-cli temp extruder [temp]` - set target temperature of extruder
118+
119+
`octoprint-cli temp bed [temp]` - set target temperature of print bed
120+
121+
</details>
122+
123+
<details>
124+
<summary><b>System Commands</b></summary><br>
125+
126+
`octoprint-cli system restart` - restart OctoPrint server
127+
128+
`octoprint-cli system restart-safe` - restart OctoPrint server to safe mode
129+
130+
`octoprint-cli reboot` - reboot OctoPrint server
131+
132+
`octoprint-cli shutdown` - shutdown OctoPrint server
133+
134+
</details>
135+
136+
<details>
137+
<summary><b>File Commands</b></summary><br>
138+
139+
`octoprint-cli files list` - list files on OctoPrint server, listing in folders can be done with `-p [PATH]` flag
140+
141+
`octoprint-cli files info [file]` - get information on file on server
142+
143+
`octoprint-cli files upload [file]` - upload local file to server
144+
145+
</details>
146+
147+
The `-h` or `--help` flag can bring up a help message for all commands
100148

101149
## Completions
102150

0 commit comments

Comments
 (0)