summaryrefslogtreecommitdiffhomepage
path: root/tools
diff options
context:
space:
mode:
authorAva Hahn <110854134+avahahn@users.noreply.github.com>2024-07-16 14:07:57 -0700
committerAva Hahn <110854134+avahahn@users.noreply.github.com>2024-07-29 08:23:26 -0700
commit1b4843036d6aa10fea6c23ed455c30f4cc9d873d (patch)
tree1b85e2aff4fd6341df60a3498bc6f87e28acf2c4 /tools
parentb892e99458ec964c3af7cf8b5f973f98ba06cd4b (diff)
downloadunit-1b4843036d6aa10fea6c23ed455c30f4cc9d873d.tar.gz
unit-1b4843036d6aa10fea6c23ed455c30f4cc9d873d.tar.bz2
tools/unitctl: update readme
Signed-off-by: Ava Hahn <a.hahn@f5.com>
Diffstat (limited to 'tools')
-rw-r--r--tools/unitctl/README.md14
1 files changed, 8 insertions, 6 deletions
diff --git a/tools/unitctl/README.md b/tools/unitctl/README.md
index 977ee1a8..e6fca477 100644
--- a/tools/unitctl/README.md
+++ b/tools/unitctl/README.md
@@ -52,16 +52,16 @@ desired.
## Features (Current)
```
-CLI interface to the NGINX UNIT Control API
+CLI interface to the NGINX Unit Control API
Usage: unitctl [OPTIONS] <COMMAND>
Commands:
- instances List all running UNIT processes
- edit Open current UNIT configuration in editor
+ instances List all running Unit processes
+ edit Open current Unit configuration in editor
import Import configuration from a directory
- execute Sends raw JSON payload to UNIT
- status Get the current status of UNIT
+ execute Sends raw JSON payload to Unit
+ status Get the current status of Unit
listeners List active listeners
help Print this message or the help of the given subcommand(s)
@@ -79,7 +79,7 @@ Options:
```
- Consumes alternative configuration formats Like YAML and converts them
-- Can convert output to multiple different formats.
+- Can convert output to multiple different formats (YAML, plain JSON, highlighted JSON)
- Syntactic highlighting of JSON output
- Interpretation of Unit errors with (arguably more) useful error messages
@@ -103,6 +103,8 @@ unitd instance [pid: 79489, version: 1.32.0]:
### Start a new Unit process via docker
Unitctl can launch new containers of Unit.
These can be official Unit images or custom Unit images.
+Any container that calls `unitd` in a CMD declaration will suffice.
+
The new containers will then be shown in a call to
`unitctl instances`