Command line tool for controlling your OctoPrint 3D printer server
Project description
octoprint-cli
Python 3 command line tool for controlling OctoPrint servers
This tool uses the OctoPrint API to control and view the status of 3D printers connected to OctoPrint servers
This project is a work in progress. Some features may not work as intended or be missing. If you have suggestions or find bugs, please report them in issues. Feel free to fork this repo to fix issues or to implement new features.
Features
These are the features that have been implemented so far, more functions will be implemented in the future. Current progress on features can be found on the project board.
- Printer connection status
- Print job status
- File selection
- Pause, resume, cancel prints
- Start print
- System commands (shutdown, reboot, restart)
- Listing files/folders
- Retrieving file/folder information
- Setting extruder and bed temperature
- Connect and disconnect from printer
- Continuous status output with temperature status and progress bar
- GCODE and STL file uploads to server storage
- Run G-code on printer from terminal
- Layer information from OctoPrint-DisplayLayerProgress plugin if installed on server
Limitations
Currently, octoprint-cli is limited to only printers with a single extruder and heated bed. Support for additional extruders and heated chambers may be implemented in the future. This program has been tested on OctoPi 0.17.0 on the Raspberry Pi 4 running OctoPrint 1.4.1 with a Monoprice Select Mini V2.
Colored and formatted text is not available on Windows systems due to the lack of support on cmd and powershell terminals
The program requires the API key to have all permissions to run
Installation
octoprint-cli can be installed from PyPI using pip
. PyPI package can be found at https://pypi.org/project/octoprint-cli/
pip install octoprint-cli
octoprint-cli can also be installed manually using git
and setup.py
git clone https://github.com/UserBlackBox/octoprint-cli.git
cd octoprint-cli
python3 setup.py install --user
Dependencies
Can be found in requirements.txt
and installed with pip
- termcolor
- requests
Configuration
The tool reads its configuration from either config.ini
in the application directory or from ~/.config/octoprint-cli.ini
on Linux systems
A sample config file has been included in sample-config.ini
[server]
;Set OctoPrint server address and x-api-key
ServerAddress = SERVER_ADDRESS_HERE
ApiKey = API_KEY_HERE
[preferences]
;Set if the program uses colored or formatted text, this setting is turned off on windows due to cmd and powershell limitations
FormattedText = true
;Set if the program should check for updates
UpdateCheck = true
[printer]
;Set maximum temperature that printer can be set to
MaxExtruderTemp = 250
MaxBedTemp = 85
Usage
General Commands
octoprint-cli version
- get OctoPrint server version information
octoprint-cli continuous
- get continuous refreshing temperature, layer, and print status
Print Commands
octoprint-cli print status
- get current print job status
octoprint-cli print select [path]
- load file on server
octoprint-cli print start
- start print job on loaded file
octoprint-cli print cancel
- cancel current print job
octoprint-cli print pause
- pauses the current print job
octoprint-cli print resume
- resumes the current print job
octoprint-cli gcode [command]
- run GCODE command on printer
octoprint-cli layers
- get layer information during prints from the DisplayLayerProgress plugin
Connection Commands
octoprint-cli connection status
- get OctoPrint print connection information
octoprint-cli connection connect
- connect to printer, serial port and baudrate are decided automatically unless specified with the -b [BAUDRATE]
and -p [PORT]
flags
octoprint-cli connection disconnect
- disconnect from printer
Temperature Commands
octoprint-cli temp status
- get current and target temperatures of extruder and bed
octoprint-cli temp extruder [temp]
- set target temperature of extruder
octoprint-cli temp bed [temp]
- set target temperature of print bed
System Commands
octoprint-cli system restart
- restart OctoPrint server
octoprint-cli system restart-safe
- restart OctoPrint server to safe mode
octoprint-cli reboot
- reboot OctoPrint server
octoprint-cli shutdown
- shutdown OctoPrint server
File Commands
octoprint-cli files list
- list files on OctoPrint server, listing in folders can be done with -p [PATH]
flag, files/folders can be filtered using the --files
and --folders
flags
octoprint-cli files info [file]
- get information on file on server
octoprint-cli files upload [file]
- upload local file to server
The -h
or --help
flag can bring up a help message for all commands
The -v
or --verbose
flag can be used to view execution information like requests, useful for debugging configuration
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file octoprint-cli-3.3.2.tar.gz
.
File metadata
- Download URL: octoprint-cli-3.3.2.tar.gz
- Upload date:
- Size: 25.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/57.0.0 requests-toolbelt/0.9.1 tqdm/4.55.1 CPython/3.9.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | dd1c0d68be0fc2ed6ce0d9d737e1bf4930cd3efb7f7dff1dc7831dc80437353b |
|
MD5 | 385cc4a2cbe3c5c038f19a32e1e4401b |
|
BLAKE2b-256 | 44c6f6b774fb4dc275e223be344f224723169279c1e7272bfefe0a63ceaa7220 |
File details
Details for the file octoprint_cli-3.3.2-py3-none-any.whl
.
File metadata
- Download URL: octoprint_cli-3.3.2-py3-none-any.whl
- Upload date:
- Size: 24.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/57.0.0 requests-toolbelt/0.9.1 tqdm/4.55.1 CPython/3.9.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | af50f653db6506cd5241caa7bf9db613b2cde90926b8313e7a9de8f002b12ae8 |
|
MD5 | 7ac70a92caaba4e2f8b23c5a8b7097a9 |
|
BLAKE2b-256 | 9485eef05923778fc8d853775c1235490ab5263b793766b2a7c5a1a4e9e04b62 |