@ossy/cli 1.16.9 → 1.16.10

package/README.md

@@ -1,6 +1,22 @@
 # @ossy/cli
 
-Unified CLI for the Ossy platform: app build and CMS workflows.
+Unified CLI for the Ossy platform.
+
+## Install
+
+```bash
+npm install -g @ossy/cli
+```
+
+After install, the `ossy` command is on your PATH:
+
+```bash
+ossy --version
+ossy --help
+ossy <command> --help
+```
+
+For one-off use without installing, you can still run `npx @ossy/cli <command>`.
 
 ## Commands
 
@@ -15,7 +31,7 @@ Unified CLI for the Ossy platform: app build and CMS workflows.
 ## App: build
 
 ```bash
-npx @ossy/cli build
+ossy build
 ```
 
 Options: e.g. `--config` for `src/config.js`. See `packages/app/README.md` for app build behavior.
@@ -51,7 +67,7 @@ Container deploys assume **Amazon ECR** in **`deployments.json`** (`registry` li
 cd packages/my-website
 export OSSY_API_KEY=<ossy-api-jwt>   # or pass --authentication <ossy-api-jwt>
 
-npx @ossy/cli publish \
+ossy publish \
   --platforms-path ../infrastructure/platforms.json \
   --deployments-path "../infrastructure/deployments/**/*.json"
 ```
@@ -77,7 +93,7 @@ Upload resource templates to your workspace so they can be used in the UI.
 Prefer **`--authentication` / `-a`** for the **Ossy API JWT** (same as **`publish`**); it matches **`OSSY_API_KEY`** in CI.
 
 ```bash
-npx @ossy/cli cms upload --authentication <ossy-api-jwt> --config src/config.js
+ossy cms upload --authentication <ossy-api-jwt> --config src/config.js
 # optional: --api-url https://api.ossy.se/api/v0  (or set OSSY_API_URL)
 # In CI you may omit --authentication when OSSY_API_KEY is set
 ```
@@ -119,7 +135,7 @@ jobs:
 Validate an ossy config file before uploading:
 
 ```bash
-npx @ossy/cli cms validate --config src/config.js
+ossy cms validate --config src/config.js
 ```
 
 When **`--config`** is omitted, **`./src/config.js`** is used if it exists.
@@ -137,8 +153,8 @@ When **`--config`** is omitted, **`./src/config.js`** is used if it exists.
 Scaffold a new Ossy app:
 
 ```bash
-npx @ossy/cli init
-npx @ossy/cli init my-app
+ossy init
+ossy init my-app
 ```
 
 Creates `src/home.page.jsx`, `src/config.js`, and `package.json` (if missing).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ossy/cli",
-  "version": "1.16.9",
+  "version": "1.16.10",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ossy-se/packages.git"
@@ -15,10 +15,12 @@
   },
   "author": "Ossy <yourfriends@ossy.se> (https://ossy.se)",
   "license": "MIT",
-  "bin": "./src/index.js",
+  "bin": {
+    "ossy": "./src/index.js"
+  },
   "dependencies": {
     "@babel/parser": "^7.28.6",
-    "@ossy/app": "^1.16.9",
+    "@ossy/app": "^1.16.10",
     "arg": "^5.0.2",
     "glob": "^10.3.10"
   },
@@ -30,5 +32,5 @@
     "/src",
     "README.md"
   ],
-  "gitHead": "be7612ac40cc49e027b0e417938cda738e19cd58"
+  "gitHead": "5821b2cea64c9ca0ece35d65a463006852abf167"
 }

package/src/index.js

@@ -1,17 +1,104 @@
 #!/usr/bin/env node
+import fs from 'node:fs'
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
 import { build } from '@ossy/app'
 import * as Cms from './cms/cli.js'
 import * as Init from './init/cli.js'
 import { publish } from './publish/cli.js'
 import * as Registry from './registry/cli.js'
 
-const [,, command, ...restArgs] = process.argv
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+const pkg = JSON.parse(
+  fs.readFileSync(path.join(__dirname, '..', 'package.json'), 'utf8')
+)
 
-if (!command) {
-  console.error(
-    '[@ossy/cli] No command provided. Usage: ossy build [--worker] | publish | registry <subcommand> | init | cms <subcommand>'
-  )
-  process.exit(1)
+const HELP = `ossy ${pkg.version}
+Command line tool for the Ossy platform.
+
+Usage:
+  ossy <command> [options]
+
+Commands:
+  init [dir]              Scaffold a new Ossy app
+  build                   Production build of the app in the current directory
+  publish                 Deploy a site and upload templates / site artifacts
+  cms <subcommand>        Resource template workflows: upload | validate
+  registry <subcommand>   Container registry helpers: ecr-push-credentials
+
+Options:
+  -h, --help              Show this help, or for a command: ossy <command> --help
+  -v, --version           Print the installed version
+`
+
+const SUBCOMMAND_HELP = {
+  init: `ossy init [dir]
+  Scaffold a new Ossy app in [dir] (defaults to current directory).
+  Creates src/home.page.jsx, src/config.js, and package.json (if missing).
+`,
+  build: `ossy build
+  Run the production build for the app in the current directory.
+  See the @ossy/app README for build options.
+`,
+  publish: `ossy publish [options]
+  Deploy via @ossy/deployment-tools, then optionally upload resource templates
+  and site artifacts.
+
+Options:
+  -a, --authentication        Ossy API JWT (or set OSSY_API_KEY)
+  -d, --domain                Site domain
+  -p, --platform              Target deployment platform
+  -c, --config                Path to src/config.js
+  --platforms-path            Path to platforms.json
+  --deployments-path          Glob for deployments JSON files
+  --all                       Deploy all sites for the platform
+  --skip-resource-templates   Skip post-deploy resource-template upload
+  --skip-site-artifacts       Skip post-deploy site-artifact upload
+  --site-artifacts-build-dir  Override the site build directory
+  --api-url                   API base URL for CMS calls
+`,
+  cms: `ossy cms <subcommand>
+  Subcommands:
+    upload    Upload resource templates from src/config.js to the workspace
+    validate  Validate ossy app config and resource templates locally
+
+Options (upload):
+  -a, --authentication  Ossy API JWT (or set OSSY_API_KEY)
+  -c, --config          Path to src/config.js
+  --api-url             API base URL for CMS calls
+
+Options (validate):
+  -c, --config          Path to src/config.js
+`,
+  registry: `ossy registry <subcommand>
+  Subcommands:
+    ecr-push-credentials  Fetch a short-lived ECR password for docker login
+
+Options:
+  -a, --authentication  Ossy API JWT (or set OSSY_API_KEY)
+  --workspace-id        Workspace id
+  --format              json | github-actions
+`,
+}
+
+const isHelpFlag = (a) => a === '--help' || a === '-h'
+const isVersionFlag = (a) => a === '--version' || a === '-v'
+
+const [, , command, ...restArgs] = process.argv
+
+if (command === undefined || isHelpFlag(command)) {
+  console.log(HELP)
+  process.exit(0)
+}
+
+if (isVersionFlag(command)) {
+  console.log(pkg.version)
+  process.exit(0)
+}
+
+if (restArgs.some(isHelpFlag) && SUBCOMMAND_HELP[command]) {
+  console.log(SUBCOMMAND_HELP[command])
+  process.exit(0)
 }
 
 const run = async () => {
@@ -36,6 +123,7 @@ const run = async () => {
     return
   }
   console.error(`[@ossy/cli] Unknown command: ${command}`)
+  console.error('Run `ossy --help` for available commands.')
   process.exit(1)
 }