axs-s3

AXS Platform secure file upload CLI

Upload files directly to your AXS data exchange folder from your terminal — no curl knowledge needed, supports multi-GB files automatically.

Installation

Requirements: Node.js v18+

Local install (current)

# Send the axs-s3-cli/ folder to the client, then:
cd axs-s3-cli
npm install -g .

From npm (once published)

npm install -g axs-s3

Setup (One Time)

Set your platform URL so you don't have to type it every time:

axs-s3 config

It will prompt:

axs-s3 setup

  Platform URL []: https://your-platform.axs.com

  ✓ Saved to ~/.axs-s3/config.json

Upload a File

axs-s3 <upload-key> <file>

Example

axs-s3 ukp_abc123xyz456... ./sales-data-q1.csv

Output:

  axs-s3 upload
  ─────────────────────────────────
  File    : sales-data-q1.csv
  Size    : 4.20 GB
  Platform: https://your-platform.axs.com

  → Initiating upload... done
  → Uploading 215 chunk(s) of 20 MB each...

  [████████████████████████████░░] 93% — part 200/215

  [██████████████████████████████] 100% — done (142.3s · avg 30.15 MB/s)

  → Finalizing... done

  ✓ Upload complete!
  ✓ S3 Key : clients/your-company/incoming/sales-data-q1.csv

Override URL for One Upload

axs-s3 ukp_abc123... ./archive.zip --url https://staging-platform.axs.com

Commands

| Command | Description | |---|---| | axs-s3 config | Set / update your platform URL | | axs-s3 <key> <file> | Upload a file | | axs-s3 <key> <file> --url <url> | Upload with a one-time URL override | | axs-s3 --help | Show help |

Security

• Your upload key is direction-locked — it can only upload files to your incoming/ folder. It cannot read, download, or delete any files.
• Keys can be revoked from the platform at any time.
• Config is stored locally at ~/.axs-s3/config.json — never sent anywhere except as the auth header during upload.