npm - @tolinax/ayoune-cli - Versions diffs - 2026.2.0 → 2026.2.1 - Mend

@tolinax/ayoune-cli 2026.2.0 → 2026.2.1

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

package/index.js ADDED Viewed

@@ -0,0 +1,11 @@
+#! /usr/bin/env node
+import { Command } from "commander";
+import { createSpinner } from "nanospinner";
+import { initializeSettings } from "./lib/helpers/initializeSettings.js";
+import { createProgram } from "./lib/commands/createProgram.js";
+//Create new command instance
+const program = new Command();
+initializeSettings();
+//Setup spinner - output to stderr so stdout stays clean for piping
+export const spinner = createSpinner("Getting data...", { stream: process.stderr });
+createProgram(program);

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@tolinax/ayoune-cli",
-  "version": "2026.2.0",
+  "version": "2026.2.1",
   "description": "",
   "type": "module",
   "main": "./index.js",

package/README.md DELETED Viewed

@@ -1,505 +0,0 @@
-# @tolinax/ayoune-cli
-```
-     __     ______  _    _
-     \ \   / / __ \| |  | |
-   __ \ \_/ / |  | | |  | |_ __   ___
-  / _` \   /| |  | | |  | | '_ \ / _ \
- | (_| || | | |__| | |__| | | | |  __/
-  \__,_||_|  \____/ \____/|_| |_|\___|
-```
-The official CLI for the **aYOUne Business-as-a-Service** platform. Manage your business modules, collections, and entries directly from the terminal.
-## Installation
-```bash
-npm install -g @tolinax/ayoune-cli
-```
-After installation, the `ay` command is available globally. On first run, the CLI will guide you through authentication automatically.
-## Quick Start
-```bash
-# Browse modules interactively
-ay modules
-# Jump straight to a module and collection
-ay m crm consumers
-# List entries in a collection
-ay list contacts
-# Fetch all pages at once
-ay list contacts --all
-# Filter output with JMESPath
-ay list products --jq '[].{name: name, price: price}'
-# Show who you're logged in as
-ay whoami
-```
-## Commands
-### Data Commands
-| Command | Alias | Description |
-|---------|-------|-------------|
-| `ay list [collection]` | `l` | List entries in a collection with pagination |
-| `ay get [collection]` | `g` | Retrieve entries with field selection |
-| `ay create [collection] [name]` | `c` | Create a new entry |
-| `ay edit [collection] [id]` | `e` | Edit an entry by ID |
-| `ay copy [collection] [id]` | `cp` | Duplicate an entry |
-| `ay describe [collection] [id]` | `d` | Show a detailed YAML description of an entry |
-| `ay audit [collection] [id]` | `history` | View the change history of an entry |
-### Real-Time Commands
-| Command | Alias | Description |
-|---------|-------|-------------|
-| `ay stream` | `listen` | Subscribe to real-time data changes via WebSocket |
-| `ay events` | `sub` | Subscribe to filtered events via WebSocket |
-### Auth & Session Commands
-| Command | Alias | Description |
-|---------|-------|-------------|
-| `ay login` | `auth` | Authenticate via browser-based login |
-| `ay logout` | `signout` | Clear stored credentials |
-| `ay whoami` | `who` | Display the currently authenticated user |
-| `ay storage` | `s` | Display stored session data and preferences |
-### Utility Commands
-| Command | Alias | Description |
-|---------|-------|-------------|
-| `ay modules [module] [collection]` | `m` | Browse modules interactively, or jump to a specific module/collection |
-| `ay completions <shell>` | `completion` | Generate shell completion script |
-| `ay alias` | | Manage custom command aliases |
-## Global Options
-These options are available on all commands:
-| Option | Description | Default |
-|--------|-------------|---------|
-| `-r, --responseFormat <format>` | Output format: `json`, `csv`, `yaml`, `table` | `json` |
-| `-v, --verbosity <level>` | Meta info level: `default`, `extended`, `minimal` | `default` |
-| `-m, --hideMeta` | Return only payload, no meta information | `false` |
-| `-s, --save` | Save the response to a file | |
-| `-d, --debug` | Show detailed request/response information | |
-| `-o, --outPath [filePath]` | Output directory for saved files | `~/aYOUne` |
-| `-n, --name [fileName]` | Custom filename for saved output | |
-| `-q, --quiet` | Suppress all output except errors and results | |
-| `--force` | Skip confirmation prompts for destructive actions | |
-| `--dry-run` | Preview what a mutating command would do without executing | |
-| `--jq <expression>` | Filter JSON output using a JMESPath expression | |
-| `--columns <fields>` | Comma-separated list of columns to display | |
-| `--no-color` | Disable colored output | |
-## Usage Examples
-### Listing and Querying
-```bash
-# List contacts, page 2, 50 per page
-ay list contacts -p 2 -l 50
-# Fetch all pages automatically
-ay list contacts --all
-# Get products as YAML and save to file
-ay get products -r yaml -s
-# Get only specific fields from orders
-ay get orders -i status total customerName
-# List invoices as CSV
-ay list invoices -r csv
-```
-### Filtering Output
-```bash
-# Extract just names using JMESPath
-ay list contacts --jq '[].name'
-# Filter to entries matching a condition
-ay list products --jq "[?price > \`100\`]"
-# Show only specific columns
-ay list contacts --columns name,email,phone
-# Combine columns and JMESPath
-ay list orders --columns status,total --jq '[?status == `open`]'
-```
-### Entry Operations
-```bash
-# Create a new contact
-ay create contacts "John Doe"
-# Edit a contact by ID
-ay edit contacts 64a1b2c3d4e5
-# Copy (duplicate) an entry
-ay copy contacts 64a1b2c3d4e5
-# Describe an entry in YAML format
-ay describe contacts 64a1b2c3d4e5
-# View audit history
-ay audit contacts 64a1b2c3d4e5
-```
-### Interactive Module Browser
-```bash
-# Start the interactive module browser
-ay modules
-# Jump directly to a module
-ay m crm
-# Jump directly to a module and collection
-ay m crm consumers
-```
-Module and collection arguments accept both slugs and labels (e.g., `crm` or `customer relationship management`).
-When browsing interactively, entries are displayed with searchable names. The following actions are available on any entry:
-- **describe** - View full YAML representation
-- **edit** - Edit fields interactively
-- **edit raw** - Edit the raw response
-- **download** - Save the entry to a file
-- **copy** - Duplicate the entry
-- **delete** - Delete the entry (with confirmation, or skip with `--force`)
-### Real-Time Streams
-```bash
-# Stream all data changes as JSON
-ay stream
-# Stream changes in YAML format
-ay stream -f yaml
-# Listen to all events
-ay events
-# Filter events by category and action
-ay events -c sales -a create
-# Subscribe to CRM events as YAML
-ay events -f yaml -c crm
-```
-### Debug Mode
-```bash
-# Show full request/response details
-ay list contacts --debug
-# Combine with other options
-ay m crm consumers --debug
-```
-Debug mode displays the HTTP method, URL, query params, auth token (truncated), response status, timing, and response body for every API call.
-### Dry Run
-```bash
-# Preview what a delete would do without executing
-ay modules --dry-run
-# Navigate to an entry, select "delete" → shows the request that would be sent
-# Works with any mutating operation (create, edit, copy, delete)
-```
-### Quiet Mode and Piping
-The spinner outputs to `stderr`, so `stdout` stays clean for piping even without `--quiet`:
-```bash
-# Pipe JSON output to jq
-ay list contacts | jq '.[].name'
-# Suppress spinner entirely for scripting
-ay list contacts -q | jq '.[].name'
-# Pipe CSV output to a file
-ay get products -r csv -q > products.csv
-# Use in shell scripts with proper exit codes
-ay get orders -q || echo "Failed with exit code $?"
-```
-### Force Mode
-```bash
-# Delete without confirmation prompt
-ay modules --force
-# Navigate to entry, select delete → no confirmation asked
-```
-## Authentication
-aYOUne CLI uses browser-based authentication:
-1. Run `ay login` (or just run any command — first-run onboarding will trigger login automatically)
-2. A clickable URL is displayed in the terminal, and a browser window opens with the aYOUne login page
-3. After successful login, the CLI receives a token via WebSocket
-4. Tokens are stored locally at `~/.aYOUne/storage/`
-Sessions persist across CLI invocations. When a session expires (HTTP 401), the CLI automatically re-authenticates and retries the request.
-## Configuration
-### Environment Variables
-| Variable | Description | Default |
-|----------|-------------|---------|
-| `AYOUNE_AUDIT_URL` | Audit service URL | `https://audit.ayoune.app` |
-| `AYOUNE_NOTIFIER_URL` | Notifier/WebSocket URL | `https://notifier.ayoune.app` |
-| `AYOUNE_LOGIN_URL` | Browser login URL | `https://login.ayoune.app` |
-| `AYOUNE_VERSION` | CLI version sent as `ref` param | Auto-detected |
-| `NO_COLOR` | Disable colored output (see [no-color.org](https://no-color.org)) | |
-### API Routing
-Each module has its own API endpoint following the pattern `https://{module}-api.ayoune.app`. For example:
-- CRM → `https://crm-api.ayoune.app`
-- Accounting → `https://accounting-api.ayoune.app`
-Services (audit, notifier, login) use their own dedicated domains.
-### Config File
-Create a config file at one of these locations (checked in order):
-- `~/.config/ayoune/config.json`
-- `~/.ayounerc`
-```json
-{
-  "profile": "production",
-  "profiles": {
-    "production": {
-      "auditUrl": "https://audit.ayoune.app",
-      "notifierUrl": "https://notifier.ayoune.app",
-      "loginUrl": "https://login.ayoune.app"
-    },
-    "staging": {
-      "auditUrl": "https://staging-audit.ayoune.app",
-      "notifierUrl": "https://staging-notifier.ayoune.app",
-      "loginUrl": "https://staging-login.ayoune.app"
-    }
-  },
-  "defaults": {
-    "responseFormat": "json",
-    "verbosity": "default",
-    "outPath": "~/my-exports"
-  }
-}
-```
-### Rate Limiting
-The CLI automatically handles rate limits (HTTP 429). When rate-limited:
-1. If the server sends a `Retry-After` header, the CLI waits the specified duration
-2. Otherwise, it uses exponential backoff (1s, 2s, 4s)
-3. Up to 3 retries are attempted before failing
-Network errors and server errors (5xx) are also retried automatically.
-## Shell Completions
-Enable tab-completion for commands and options:
-```bash
-# Bash
-ay completions bash >> ~/.bashrc
-# Zsh
-ay completions zsh >> ~/.zshrc
-# Fish
-ay completions fish > ~/.config/fish/completions/ay.fish
-# PowerShell
-ay completions powershell >> $PROFILE
-```
-Restart your shell after adding completions.
-## Custom Aliases
-Create shortcuts for frequently used commands:
-```bash
-# Create an alias
-ay alias set ll "list leads"
-ay alias set gp "get products -r yaml"
-# Use it
-ay ll                    # Runs: ay list leads
-ay gp                   # Runs: ay get products -r yaml
-# List all aliases
-ay alias list
-# Remove an alias
-ay alias remove ll
-```
-Aliases are stored in `~/.config/ayoune/aliases.json`.
-## Supported Modules
-The aYOUne platform provides the following business modules:
-| Module | Slug | API Endpoint |
-|--------|------|--------------|
-| Artificial Intelligence | `ai` | `ai-api.ayoune.app` |
-| Asset Store | `assetstore` | `assetstore-api.ayoune.app` |
-| Customer Relationship Management | `crm` | `crm-api.ayoune.app` |
-| Project Management | `pm` | `pm-api.ayoune.app` |
-| Content Management System | `cms` | `cms-api.ayoune.app` |
-| Marketing | `marketing` | `marketing-api.ayoune.app` |
-| Automation | `automation` | `automation-api.ayoune.app` |
-| Sale | `sale` | `sale-api.ayoune.app` |
-| Product Information Management | `pim` | `pim-api.ayoune.app` |
-| Hub | `hub` | `hub-api.ayoune.app` |
-| Human Resources | `hr` | `hr-api.ayoune.app` |
-| Service Desk | `service` | `service-api.ayoune.app` |
-| Purchase | `purchase` | `purchase-api.ayoune.app` |
-| Accounting | `accounting` | `accounting-api.ayoune.app` |
-| E-Commerce | `ecommerce` | `ecommerce-api.ayoune.app` |
-| Monitoring | `monitoring` | `monitoring-api.ayoune.app` |
-| Research | `research` | `research-api.ayoune.app` |
-| Production | `production` | `production-api.ayoune.app` |
-| Affiliate | `affiliate` | `affiliate-api.ayoune.app` |
-| Reporting | `reporting` | `reporting-api.ayoune.app` |
-| Export | `export` | `export-api.ayoune.app` |
-| Configuration | `config` | `config-api.ayoune.app` |
-| Audit | `audit` | `audit-api.ayoune.app` |
-## Exit Codes
-The CLI uses standard exit codes for scripting compatibility:
-| Code | Meaning |
-|------|---------|
-| `0` | Success |
-| `1` | General error |
-| `2` | Misuse (missing arguments, non-interactive terminal) |
-| `4` | Authentication required (session expired) |
-| `5` | Permission denied (insufficient rights) |
-| `6` | Configuration error |
-## Local Storage
-The CLI persists session data and context at `~/.aYOUne/storage/`:
-| Key | Description |
-|-----|-------------|
-| `token` | JWT access token |
-| `refreshToken` | Refresh token for re-authentication |
-| `lastModule` | Last used module slug |
-| `lastCollection` | Last used collection name |
-| `lastId` | Last used entry ID |
-Commands like `edit`, `copy`, `describe`, and `audit` default to the last used collection and ID when arguments are omitted.
-## Development
-### Prerequisites
-- Node.js >= 18
-- npm >= 9
-### Setup
-```bash
-git clone git@bitbucket.org:ayoune/ayoune-cli.git
-cd ayoune-cli
-npm install
-```
-### Scripts
-```bash
-npm run build          # Clean dist/, compile TypeScript, copy package.json
-npm run test           # Run tests with Vitest
-npm run test:watch     # Run tests in watch mode
-npm run lint           # Lint source with ESLint
-npm run format         # Format source with Prettier
-npm run format:check   # Check formatting without writing
-npm run release        # Bump version, generate changelog, tag, push, publish
-```
-### Project Structure
-```
-src/
-  index.ts                          # Entry point, spinner (stderr), program init
-  data/
-    modules.ts                      # Business module definitions
-    services.ts                     # External service definitions
-    operations.ts                   # Available operations (list, get)
-    defaultActions.ts               # Entry actions (edit, delete, copy, ...)
-    modelsAndRights.ts              # Collection-to-rights mapping
-  lib/
-    types.ts                        # Shared TypeScript interfaces
-    exitCodes.ts                    # Exit code constants
-    commands/
-      createProgram.ts              # Root program, global options, command wiring
-      create{Name}Command.ts        # Command factory per subcommand
-    operations/
-      handle{Name}Operation.ts      # Business logic per operation
-    prompts/
-      prompt{Name}.ts               # Interactive prompt helpers
-    api/
-      apiClient.ts                  # Axios instance with retry & rate limit handling
-      apiCallHandler.ts             # API call wrapper with auth & dry-run
-      auditCallHandler.ts           # Audit API call wrapper
-      handleAPIError.ts             # Centralized error handler
-      login.ts                      # WebSocket-based auth flow
-    helpers/
-      config.ts                     # Environment-based configuration
-      handleResponseFormatOptions.ts # Output formatter with JMESPath & column filtering
-      localStorage.ts               # File-based persistent storage
-      saveFile.ts                   # File output handler
-      initializeSettings.ts         # Inquirer plugin registration
-    models/
-      getModuleFromCollection.ts    # Collection-to-module resolver
-      getModelsInModules.ts         # Models-per-module lookup
-      getCollections.ts             # All collection names
-    socket/
-      customerSocketClient.ts       # Socket.IO client for real-time
-```
-### Architecture
-- **Command Factory Pattern**: Each command is defined in `create{Name}Command.ts` and registered in `createProgram.ts`
-- **Operation Handlers**: Business logic lives in `handle{Name}Operation.ts`, keeping commands thin
-- **Prompt Helpers**: Interactive prompts are encapsulated in `prompt{Name}.ts` using Inquirer with searchable entry selection
-- **API Layer**: Per-module routing (`{module}-api.ayoune.app`), Axios with 3 retries, automatic Bearer token attachment, 401 auto-re-login, rate limit handling, centralized error handling
-- **Output Formatting**: All API responses pass through `handleResponseFormatOptions` for consistent JSON/YAML/CSV/table output with optional JMESPath and column filtering
-- **Non-Interactive Support**: TTY detection skips prompts and requires explicit arguments when piped
-- **Piping-Safe**: Spinner outputs to `stderr`, data to `stdout`
-### Conventions
-- **Imports**: Use `.js` extensions in import paths (required for ESM output)
-- **Commit Messages**: Follow [Conventional Commits](https://www.conventionalcommits.org/) (`feat:`, `fix:`, `chore:`, etc.)
-- **TypeScript**: `strict: false`, target ES2018, ESNext modules
-- **Interfaces**: Use `I` prefix (e.g., `ICommandOptions`, `IApiResponse`)
-## License
-ISC