4 releases
new 0.2.1 | Oct 25, 2024 |
---|---|
0.2.0 | Feb 4, 2024 |
0.1.1 | Aug 29, 2022 |
0.1.0 | Apr 24, 2022 |
#2716 in Command line utilities
29 downloads per month
120KB
2.5K
SLoC
kvarnctl
Communication with Kvarn from the command line.
kvarnctl takes a command from you and sends it to Kvarn.
The Kvarn instance listening for commands may implement arbitrary commands through the plugin interface.
See the CI on GitHub for Linux downloads.
Custom ctl path
If you configured Kvarn to listen to a custom path,
you can specify it using the -p
flag. If the path is relative, its base
is /run/user/<uid>/
for users and /run/
for root.
Common commands
kvarnctl shutdown
- this gracefully shuts Kvarn down (if the Kvarn featuregraceful-shutdown
is enabled)kvarnctl reload
- handover to the new binary, located on the same path as the current was started on.kvarnctl ping <message>
- test if the Kvarn instance is responsive. It will return<message>
and print it to the terminal.kvarnctl wait
- waits for Kvarn to shut downkvarnctl clear <method> (<host> <file/URI>)
- clears caches. Methods available areall
,files
,responses
, and two which clear a specific resource,file
andresponse
.
Platform support
This isn't supported on Windows as it relies on UNIX socket.
It's unfeasible we get this working on Windows, as handover isn't possible and the need for remote management on Windows is a very slim market. PRs to kvarn-socket
with named pipe support is however welcome :)
Changelog
v0.1.1
- Update to
kvarn_utils = "0.5"
Dependencies
~5–14MB
~164K SLoC