@orderly.network/cli 1.0.0 → 2.2.3

package/README.md

@@ -1,127 +1,40 @@
 # @orderly.network/cli
 
-CLI tool for Orderly Network trading with secure OS keychain authentication.
+The Orderly Network CLI. Installs the native `orderly` binary for your platform
+as an optional dependency — no install scripts, nothing downloaded at runtime.
 
-## Features
+## Install
 
-- **Secure key storage** - Wallet and API keys stored in OS keychain (never in files)
-- **AI-friendly** - Keys never exposed to AI context, CLI returns only results
-- **Full trading support** - Place/cancel orders, manage positions, set leverage
-- **Multi-chain** - Supports EVM (Arbitrum, Base, Optimism, etc.) and Solana
-
-## Installation
-
-```bash
+```sh
 npm install -g @orderly.network/cli
+orderly --version
 ```
 
-### Requirements
-
-- **Node.js >= 22**
-- **Linux**: `sudo apt install libsecret-1-0 libsecret-1-dev` (for OS keychain support)
-
-## Quick Start (Testnet)
-
-```bash
-# 1. Create a new EVM wallet
-orderly wallet-create --type EVM --network testnet
-
-# 2. Register Orderly account
-orderly wallet-register --broker-id demo --network testnet
-
-# 3. Request test USDC (wait a few minutes for delivery)
-orderly faucet-usdc <address> --broker-id demo --chain-id 421614 --network testnet
-
-# 4. Add API key for trading (generates Ed25519 key automatically)
-orderly wallet-add-key --broker-id demo --scope read,trading --network testnet
-
-# 5. List accounts to get your account ID
-orderly auth-list --network testnet
-
-# 6. Check balance
-orderly account-balance --account <account-id> --network testnet
-
-# 7. Place an order
-orderly order-place PERP_ETH_USDC BUY MARKET 0.01 --account <account-id> --network testnet
-```
-
-**Note:** The `--account` flag is required for all authenticated commands. Use `auth-list` to see available accounts.
-
-## Common Commands
-
-```bash
-# Account management
-orderly account-info --account <account-id>
-orderly account-balance --account <account-id>
-
-# Trading - Orders
-orderly order-place PERP_ETH_USDC BUY LIMIT 0.01 --price 3500 --account <account-id>
-orderly order-place PERP_ETH_USDC BUY MARKET 0.01 --client-order-id my-order-123 --account <account-id>
-orderly order-cancel <order-id> --symbol PERP_ETH_USDC --account <account-id>
-orderly order-list --status NEW --account <account-id>
-
-# Trading - Algo Orders (TP/SL)
-orderly algo-order-place PERP_ETH_USDC BUY STOP 0.01 --trigger-price 2000 --account <account-id>
-orderly algo-order-place PERP_ETH_USDC SELL TP_SL 0.01 --tp-trigger-price 2500 --sl-trigger-price 1500 --account <account-id>
-orderly algo-order-list --account <account-id>
-
-# Positions
-orderly positions-list --account <account-id>
-orderly positions-close PERP_ETH_USDC --account <account-id>
-
-# Market data
-orderly market-price PERP_ETH_USDC
-orderly market-trades PERP_ETH_USDC --limit 20
-orderly funding-rates
-orderly kline PERP_ETH_USDC 1h --limit 100 --account <account-id>
-orderly symbols
-```
-
-## Output Format
+Or without installing:
 
-By default, output is compact JSON (no whitespace) for AI/programmatic use:
-
-```bash
-orderly market-price PERP_ETH_USDC
-# {"symbol":"PERP_ETH_USDC","index_price":2124.82,"mark_price":2124.89,...}
-```
-
-Use `--csv` for tabular data (more token-efficient for lists):
-
-```bash
-orderly symbols --csv
-# symbol,index_price,mark_price,...
-# PERP_ETH_USDC,2124.82,2124.89,...
-# PERP_BTC_USDC,71551.7,71551.7,...
+```sh
+npx @orderly.network/cli auth-list
 ```
 
-## Security
+### Platforms
 
-- Private keys are stored in the OS keychain:
-  - **macOS**: Keychain
-  - **Windows**: Credential Manager
-  - **Linux**: libsecret/gnome-keyring
+| OS | Architectures |
+| --- | --- |
+| Linux (static musl) | x86_64, arm64 |
+| macOS | x86_64, arm64 |
+| Windows | x86_64, arm64 |
 
-- Keys are **never**:
-  - Written to disk in plain text
-  - Exposed in CLI output
-  - Accessible to AI agents
+The binary lives in `@orderly.network/cli-<os>-<cpu>`. If your npm config skips
+optional dependencies, reinstall with `--include=optional`.
 
-## Commands
+## What it is not
 
-Run `orderly --help` for the complete command reference.
-
-## Development
-
-```bash
-yarn dev          # Watch mode build
-yarn build        # Production build
-yarn lint         # Check for issues
-yarn format       # Format code
-yarn typecheck    # TypeScript check
-yarn test         # Run tests
-```
+- **Not a JavaScript API.** Programmatic request building and signing (browser,
+  Workers, Node) is [`@orderly.network/cli-wasm`](https://www.npmjs.com/package/@orderly.network/cli-wasm).
+- **Not key storage in the package.** Wallet and API keys live in the OS keychain
+  (macOS Keychain, Windows Credential Manager, Linux Secret Service).
 
-## License
+## Links
 
-MIT
+- Source: https://gitlab.com/orderlynetwork/orderly-fe/cli
+- Installation, verification, building from source: `INSTALL.md` in the repository

package/bin/orderly.js

@@ -0,0 +1,34 @@
+#!/usr/bin/env node
+// Launcher for the native Orderly CLI.
+//
+// npm installs this package plus one platform package (os/cpu filtered). This
+// script replaces itself with that binary, inheriting stdio so TTY prompts,
+// colours and exit codes behave exactly as with a direct install.
+import { spawn } from 'node:child_process';
+import { resolveBinary } from '../lib/resolve.js';
+
+let binary;
+try {
+  binary = resolveBinary();
+} catch (error) {
+  process.stderr.write(`${error.message}\n`);
+  process.exit(1);
+}
+
+const child = spawn(binary, process.argv.slice(2), {
+  stdio: 'inherit',
+  env: process.env,
+});
+
+child.on('error', (error) => {
+  process.stderr.write(`orderly: failed to start ${binary}: ${error.message}\n`);
+  process.exit(1);
+});
+
+child.on('close', (code, signal) => {
+  if (signal) {
+    process.kill(process.pid, signal);
+    return;
+  }
+  process.exit(code ?? 1);
+});

package/lib/resolve.js

@@ -0,0 +1,64 @@
+import { createRequire } from 'node:module';
+import path from 'node:path';
+
+/**
+ * Native binaries ship as one npm package per platform. This map is the only
+ * place the launcher and the packer agree on which package holds which target;
+ * the packer's TARGETS list in scripts/npm-platforms.mjs must match.
+ */
+const PACKAGES = {
+  'linux-x64': '@orderly.network/cli-linux-x64',
+  'linux-arm64': '@orderly.network/cli-linux-arm64',
+  'darwin-x64': '@orderly.network/cli-darwin-x64',
+  'darwin-arm64': '@orderly.network/cli-darwin-arm64',
+  'win32-x64': '@orderly.network/cli-win32-x64',
+  'win32-arm64': '@orderly.network/cli-win32-arm64',
+};
+
+const requireFromHere = createRequire(import.meta.url);
+const defaultResolve = (id) => requireFromHere.resolve(id);
+
+/** npm package that carries the binary for a platform/arch pair. */
+export function packageForPlatform(platform, arch) {
+  return PACKAGES[`${platform}-${arch}`] ?? null;
+}
+
+/** Executable file name inside the platform package. */
+export function binaryName(platform) {
+  return platform === 'win32' ? 'orderly.exe' : 'orderly';
+}
+
+/**
+ * Absolute path of the native binary for this machine.
+ *
+ * `resolve` is injectable so the mapping and error paths are testable without
+ * a real install.
+ */
+export function resolveBinary(
+  platform = process.platform,
+  arch = process.arch,
+  resolve = defaultResolve
+) {
+  const pkg = packageForPlatform(platform, arch);
+  if (!pkg) {
+    throw new Error(
+      `orderly: no prebuilt CLI for ${platform}-${arch}.\n` +
+        'Supported platforms: linux (x64, arm64), macOS (x64, arm64), Windows (x64, arm64).\n' +
+        'Build from source instead: cargo install --path .'
+    );
+  }
+
+  let manifest;
+  try {
+    manifest = resolve(`${pkg}/package.json`);
+  } catch {
+    throw new Error(
+      `orderly: ${pkg} is not installed.\n` +
+        'It is an optional dependency of @orderly.network/cli, so the install either\n' +
+        'skipped optional dependencies or filtered by platform. Reinstall with:\n' +
+        '  npm install -g @orderly.network/cli --include=optional'
+    );
+  }
+
+  return path.join(path.dirname(manifest), 'bin', binaryName(platform));
+}

package/package.json

@@ -1,65 +1,31 @@
 {
   "name": "@orderly.network/cli",
-  "version": "1.0.0",
-  "description": "CLI tool for Orderly Network trading - secure keychain-based authentication",
-  "main": "dist/index.js",
+  "version": "2.2.3",
+  "description": "Orderly Network CLI: the native binary is installed as an optional dependency",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitlab.com/orderlynetwork/orderly-fe/cli.git"
+  },
+  "homepage": "https://github.com/OrderlyNetwork/cli",
   "type": "module",
   "bin": {
-    "orderly": "dist/index.js"
+    "orderly": "bin/orderly.js"
   },
-  "scripts": {
-    "build": "node scripts/build.js",
-    "dev": "node scripts/build.js --watch",
-    "start": "node dist/index.js",
-    "lint": "eslint src --ext .ts --report-unused-disable-directives --max-warnings 0",
-    "lint:fix": "eslint src --ext .ts --fix",
-    "format": "prettier --write \"src/**/*.{ts,json,md}\"",
-    "format:check": "prettier --check \"src/**/*.{ts,json,md}\"",
-    "typecheck": "tsc --noEmit",
-    "prepublishOnly": "yarn build && yarn typecheck"
+  "engines": {
+    "node": ">=18"
   },
-  "keywords": [
-    "orderly",
-    "orderly-network",
-    "cli",
-    "trading",
-    "defi",
-    "perpetuals"
-  ],
-  "author": "Orderly Network",
-  "license": "MIT",
   "files": [
-    "dist"
+    "bin",
+    "lib",
+    "README.md"
   ],
-  "publishConfig": {
-    "access": "public"
-  },
-  "dependencies": {
-    "@noble/curves": "^2.0.1",
-    "@orderly.network/default-solana-adapter": "^2.10.2",
-    "axios": "^1.13.6",
-    "bs58": "^6.0.0",
-    "cac": "6.7.14",
-    "ethers": "^6.16.0",
-    "keytar": "^7.9.0",
-    "kleur": "^4.1.5",
-    "prompts": "^2.4.2",
-    "zod": "^4.3.6"
-  },
-  "devDependencies": {
-    "@eslint/js": "^9.24.0",
-    "@types/node": "^24.0.0",
-    "@types/prompts": "^2.4.9",
-    "@typescript-eslint/eslint-plugin": "^8.57.0",
-    "@typescript-eslint/parser": "^8.57.0",
-    "esbuild": "^0.27.4",
-    "eslint": "^10.0.3",
-    "eslint-config-prettier": "^10.1.8",
-    "prettier": "^3.8.1",
-    "typescript": "^5.9.3",
-    "typescript-eslint": "^8.57.0"
-  },
-  "engines": {
-    "node": ">=22.0.0"
+  "optionalDependencies": {
+    "@orderly.network/cli-linux-x64": "2.2.3",
+    "@orderly.network/cli-linux-arm64": "2.2.3",
+    "@orderly.network/cli-darwin-x64": "2.2.3",
+    "@orderly.network/cli-darwin-arm64": "2.2.3",
+    "@orderly.network/cli-win32-x64": "2.2.3",
+    "@orderly.network/cli-win32-arm64": "2.2.3"
   }
 }