aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorColin Okay <colin@cicadas.surf>2022-08-09 10:18:03 -0500
committerColin Okay <colin@cicadas.surf>2022-08-09 10:18:03 -0500
commit33798548a62ca1610252a583875690e94c8619f6 (patch)
treed9924d25c2f63acc30daa1ee68a77a3a8e76758d
parente955869d2868a8cf867db44aad53534a92e10b92 (diff)
[change] some the useage statements for cli interface
-rw-r--r--app/draft.lisp2
-rw-r--r--app/modify.lisp12
-rw-r--r--app/run.lisp2
-rw-r--r--app/search.lisp1
4 files changed, 9 insertions, 8 deletions
diff --git a/app/draft.lisp b/app/draft.lisp
index b8cb0e6..b3ca67c 100644
--- a/app/draft.lisp
+++ b/app/draft.lisp
@@ -33,7 +33,7 @@
(defun draft/test/command ()
(cli:make-command
:name "test"
- :usage "<DRAFT> [ARG ...]"
+ :usage "[options] <draft-name> [ARG ...]"
:description "runs a draft oneliner, same options as `ol run`"
:options (run/options)
:handler #'draft/test/handler))
diff --git a/app/modify.lisp b/app/modify.lisp
index 5ad9655..ad75513 100644
--- a/app/modify.lisp
+++ b/app/modify.lisp
@@ -16,7 +16,7 @@
(defun modify/redraft/command ()
(cli:make-command
:name "redraft"
- :usage "<IDENTIFIER>"
+ :usage "<identifier>"
:description "edit an existing oneliner"
:handler #'modify/redraft/handler))
@@ -26,7 +26,7 @@
(defun modify/flag/command ()
(cli:make-command
:name "flag"
- :usage "<IDENTIFIER>"
+ :usage "<identifier>"
:description "flag a oneliner as potentially wrong or hazardous"
:handler #'modify/flag/handler))
@@ -36,7 +36,7 @@
(defun modify/unflag/command ()
(cli:make-command
:name "unflag"
- :usage "<IDENTIFIER>"
+ :usage "<identifier>"
:description "remove flagged status from a oneliner"
:handler #'modify/unflag/handler))
@@ -46,7 +46,7 @@
(defun modify/lock/command ()
(cli:make-command
:name "lock"
- :usage "<IDENTIFIER>"
+ :usage "<identifier>"
:description "lock a oneliner from being changed (admin only)"
:handler #'modify/lock/handler))
@@ -56,7 +56,7 @@
(defun modify/unlock/command ()
(cli:make-command
:name "unlock"
- :usage "<IDENTIFIER>"
+ :usage "<identifier>"
:description "unlock a locked oneliner, allowing it to be modified again"
:handler #'modify/unlock/handler))
@@ -66,7 +66,7 @@
(defun modify/delete/command ()
(cli:make-command
:name "delete"
- :usage "<IDENTIFIER>"
+ :usage "<identifier>"
:description "delete a oneliner from the server."))
(defun modify/subcommands ()
diff --git a/app/run.lisp b/app/run.lisp
index 16dbde6..ccaf246 100644
--- a/app/run.lisp
+++ b/app/run.lisp
@@ -39,7 +39,7 @@
(defun run/command ()
(cli:make-command
:name "run"
- :usage "<IDENTIFIER> [ARG ...]"
+ :usage "[options] <identifier> [arg ...]"
:description "run the identified oneliner with any arguments it might take"
:options (run/options)
:handler #'run/handler
diff --git a/app/search.lisp b/app/search.lisp
index df30526..0cd454c 100644
--- a/app/search.lisp
+++ b/app/search.lisp
@@ -83,6 +83,7 @@
(cli:make-command
:name "search"
:description "search for oneliners with provided tags"
+ :usage "[options] [term ...]"
:options (search/options)
:handler #'search/handler
:examples +search/examples+))