clubhouse-cli - npm Package Compare versions

Comparing version 0.3.0 to 0.4.0

package.json

 {
   "name": "clubhouse-cli",
-  "version": "0.3.0",
-  "description": "A command line tool for searching and updating clubhouse.io stories",
+  "version": "0.4.0",
+  "description": "A command line tool for searching,viewing, and updating clubhouse.io stories",
   "main": "index.js",
@@ -6,0 +6,0 @@ "scripts": {

README.md

@@ -8,3 +8,3 @@ # clubhouse-cli
 
-  A command line tool for searching and updating clubhouse.io stories
+  A command line tool for searching, viewing, and updating clubhouse.io stories
 
@@ -21,3 +21,3 @@
     install         install and configure API access
-    search [query]  search stories with optional query
+    find [query]    find stories with optional query
     story           view or manipulate stories
@@ -31,3 +31,3 @@ wf              list workflows and their states
 ~~~sh
-  Usage: club search [options]
+  Usage: club-find [options]
 
@@ -41,14 +41,28 @@ Search through clubouse stories
     -I, --idonly           Print only ID of story results
-    -l, --label [id|name]  Stories with label id/name
+    -l, --label [id|name]  Stories with label id/name, by regex
+    -o, --owner [name]     Stories with owner, by regex
     -p, --project [id]     Stories in project
-    -s, --state [id]       Stories in workflow state
-    -t, --text [name]      Stories with text in name
-    -y, --type [name]      Stories of type
+    -s, --state [id|name]  Stories in workflow state id/name, by regex
+    -t, --text [name]      Stories with text in name, by regex
+    -y, --type [name]      Stories of type, by regex
     -h, --help             output usage information
 ~~~
 
+Example output
+
+~~~sh
+$ club find -o 'josh' -s 'Review'
+#1480 Create Thinga-ma-bob
+  Type:    feature/3
+  Label:   #512 client_web
+  Project: #14 Customers
+  Owners:  Josh (josh)
+  State:   #500000020 Code Review
+  URL:     https://app.clubhouse.io/story/1480
+~~~
+
 ### Stories
 
 ~~~sh
-  Usage: club story [options] <id>
+  Usage: club-story [options] <id>
 
@@ -61,8 +75,25 @@ Update and/or display story details
     -I, --idonly             Print only ID of story results
-    -s, --state [id]         Update workflow state of story
+    -s, --state [id|name]    Update workflow state of story
     -e, --estimate [number]  Update estimate of story
     -c, --comment [text]     Add comment to story
+    -o, --open               Open story in browser
     -h, --help               output usage information
 ~~~
 
+Example output:
+
+~~~sh
+$ club story 1480 -c 'This is a commend'
+#1480 Create Thinga-ma-bob
+Desc:    Create a thing to display:
+Owners:  Josh (josh)
+Type:    feature/3
+Label:   #512 client_web
+Project: #14
+State:   #500000020 Code Review
+URL:     https://app.clubhouse.io/story/1480
+Comment: This is a commend
+  at: 2017-10-25T16:17:04Z
+~~~
+
 ### Workflows
@@ -69,0 +100,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

17648

increased by4.57%

Number of lines in readme file

128

increased by31.96%

No dependency changes