@terros-inc/cli 1.0.3 → 1.0.5

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Terros Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,121 @@
+# Terros CLI
+
+Command-line interface for the Terros Sales platform.
+
+## Requirements
+
+- Node.js 24 or newer
+- A Terros account with access to the platform
+
+## Install
+
+Install the CLI globally with your package manager:
+
+```sh
+npm install -g @terros-inc/cli
+```
+
+After installation, verify that the `terros` command is available:
+
+```sh
+terros help
+```
+
+## Sign In
+
+Authenticate before running Terros API commands:
+
+```sh
+terros auth login
+```
+
+The CLI opens a browser-based device login flow. Confirm that the code shown in
+your browser matches the code printed in the terminal, then finish signing in.
+
+To print the current API access token (for usage in scripts):
+
+```sh
+terros auth token
+```
+
+## Find Commands
+
+Terros CLI uses the pattern:
+
+```sh
+terros <command> <subcommand> [parameters]
+```
+
+List available commands:
+
+```sh
+terros help
+```
+
+List subcommands for a command:
+
+```sh
+terros <command> help
+```
+
+Show parameters for a subcommand:
+
+```sh
+terros <command> <subcommand> help
+```
+
+## Run a Command
+
+Pass parameters as flags:
+
+```sh
+terros <command> <subcommand> --name "Acme Inc." --active true
+```
+
+Parameter values are validated based on the Terros API schema. Supported values
+include strings, numbers, booleans, arrays, and JSON objects.
+
+Examples:
+
+```sh
+terros <command> <subcommand> --count 10
+terros <command> <subcommand> --active true
+terros <command> <subcommand> --ids id_1,id_2,id_3
+terros <command> <subcommand> --metadata '{"source":"cli"}'
+```
+
+Responses are printed as formatted JSON.
+
+## Local Development
+
+Install dependencies:
+
+```sh
+pnpm install
+```
+
+Build the CLI:
+
+```sh
+pnpm build
+```
+
+Run the CLI locally:
+
+```sh
+node dist/index.js help
+```
+
+The published `terros` executable loads the compiled code from `dist/index.js`,
+so run `pnpm build` after changing TypeScript files.
+
+## Troubleshooting
+
+If a command says the CLI is not authorized, sign in again:
+
+```sh
+terros auth login
+```
+
+If a token cannot be refreshed, the saved login may have expired. Run
+`terros auth login` to create a new session.

package/package.json

@@ -3,6 +3,15 @@
   "bin": {
     "terros": "./cli.js"
   },
+  "bugs": {
+    "url": "https://github.com/terros-inc/cli/issues"
+  },
+  "dependencies": {
+    "luxon": "^3.7.2",
+    "minimist": "^1.2.8",
+    "open": "^11.0.0",
+    "yaml": "^2.9.0"
+  },
   "description": "Command-line interface for Terros Sales platform",
   "devDependencies": {
     "@types/minimist": "^1.2.5",
@@ -10,13 +19,6 @@
     "typescript": "^6.0.3",
     "@types/luxon": "^3.7.1"
   },
-  "keywords": [
-    "terros",
-    "cli"
-  ],
-  "license": "MIT",
-  "main": "./dist/index.js",
-  "name": "@terros-inc/cli",
   "engines": {
     "node": ">=24"
   },
@@ -25,19 +27,26 @@
     "terros.yml",
     "dist"
   ],
-  "type": "module",
-  "version": "1.0.3",
-  "dependencies": {
-    "luxon": "^3.7.2",
-    "minimist": "^1.2.8",
-    "open": "^11.0.0",
-    "yaml": "^2.9.0"
-  },
+  "homepage": "https://github.com/terros-inc/cli#readme",
+  "keywords": [
+    "terros",
+    "cli"
+  ],
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "name": "@terros-inc/cli",
   "publishConfig": {
     "access": "public",
     "tag": "latest"
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/terros-inc/cli.git"
+  },
+  "type": "module",
+  "version": "1.0.5",
   "scripts": {
+    "fetch-openapi": "wget https://docs.terros.com/openapi/terros.yml",
     "build": "tsc",
     "start": "node src/index.ts"
   }