@stephendolan/helpscout-cli 2.5.0 → 2.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +16 -8
  2. package/dist/cli.js +1 -1
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -24,6 +24,7 @@ Create an OAuth app at [Help Scout > Your Profile > My Apps](https://secure.help
24
24
  helpscout auth login --app-id YOUR_APP_ID --app-secret YOUR_APP_SECRET
25
25
  helpscout auth status
26
26
  helpscout auth logout
27
+ helpscout auth refresh # Refresh access token
27
28
  ```
28
29
 
29
30
  Or use environment variables: `HELPSCOUT_APP_ID`, `HELPSCOUT_APP_SECRET`, `HELPSCOUT_MAILBOX_ID`
@@ -40,6 +41,9 @@ helpscout conversations list --summary
40
41
 
41
42
  helpscout conversations view 456
42
43
  helpscout conversations threads 456
44
+ helpscout conversations threads 456 --type customer # Filter by type
45
+ helpscout conversations threads 456 --html # HTML output
46
+ helpscout conversations threads 456 --include-notes
43
47
  helpscout conversations reply 456 --text "Thanks for reaching out!"
44
48
  helpscout conversations note 456 --text "Internal note"
45
49
  helpscout conversations add-tag 456 urgent
@@ -73,6 +77,16 @@ helpscout workflows deactivate 123
73
77
  helpscout mailboxes list
74
78
  helpscout mailboxes view 123
75
79
  helpscout mailboxes set-default 123
80
+ helpscout mailboxes get-default
81
+ helpscout mailboxes clear-default
82
+ ```
83
+
84
+ ### MCP Server
85
+
86
+ Run as an MCP server for AI agent integration:
87
+
88
+ ```bash
89
+ helpscout mcp
76
90
  ```
77
91
 
78
92
  ## Options
@@ -84,20 +98,14 @@ helpscout mailboxes set-default 123
84
98
  | `-f, --fields <fields>` | Include only specified fields |
85
99
  | `--include-metadata` | Include `_links` and `_embedded` |
86
100
 
87
- ## Output
101
+ ## Examples
88
102
 
89
103
  ```bash
90
- # Filter with jq
91
104
  helpscout conversations list | jq '.conversations[].subject'
92
-
93
- # Select fields
94
105
  helpscout conversations list --fields id,subject
95
-
96
- # Plain text bodies
97
- helpscout conversations threads 456 --plain
98
106
  ```
99
107
 
100
- Errors return: `{"error": {"name": "...", "detail": "...", "statusCode": 400}}`
108
+ Errors: `{"error": {"name": "...", "detail": "...", "statusCode": 400}}`
101
109
 
102
110
  ## References
103
111
 
package/dist/cli.js CHANGED
@@ -1279,7 +1279,7 @@ function createMcpCommand() {
1279
1279
 
1280
1280
  // src/cli.ts
1281
1281
  var program = new Command8();
1282
- program.name("helpscout").description("A command-line interface for Help Scout").version("2.5.0").option("-c, --compact", "Minified JSON output (single line)").option("-p, --plain", "Strip HTML from body fields, output plain text").option("--include-metadata", "Include _links and _embedded in responses (stripped by default)").option("-f, --fields <fields>", "Comma-separated list of fields to include in output").hook("preAction", (thisCommand) => {
1282
+ program.name("helpscout").description("A command-line interface for Help Scout").version("2.6.0").option("-c, --compact", "Minified JSON output (single line)").option("-p, --plain", "Strip HTML from body fields, output plain text").option("--include-metadata", "Include _links and _embedded in responses (stripped by default)").option("-f, --fields <fields>", "Comma-separated list of fields to include in output").hook("preAction", (thisCommand) => {
1283
1283
  const options = thisCommand.opts();
1284
1284
  setOutputOptions({
1285
1285
  compact: options.compact,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stephendolan/helpscout-cli",
3
- "version": "2.5.0",
3
+ "version": "2.6.0",
4
4
  "description": "A command-line interface for Help Scout",
5
5
  "type": "module",
6
6
  "main": "./dist/cli.js",
@@ -54,7 +54,7 @@
54
54
  },
55
55
  "devDependencies": {
56
56
  "@biomejs/biome": "^1.9.4",
57
- "@types/node": "^20.0.0",
57
+ "@types/bun": "latest",
58
58
  "oxlint": "^0.16.0",
59
59
  "tsup": "^8.0.0",
60
60
  "tsx": "^4.7.0",