APISign CLI

A command-line interface for managing APISign contracts and templates.

Installation

npm install -g apisign-io

Or using Bun:

bun add -g apisign-io

Quick Start

1. Initialize and authenticate:

apisign init
apisign auth login

2. List your templates:

apisign template list

3. Create a contract from a template:

apisign contract create -t TEMPLATE_ID -n "My Contract"

4. Send contract for signing:

apisign contract send CONTRACT_ID -e [email protected]

Authentication

The CLI supports two authentication methods:

API Key Authentication

apisign auth login --api-key YOUR_API_KEY

Create a key in the dashboard under Account > API Keys.

Browser Authentication

Not available yet. apisign auth login without --api-key calls an endpoint (/auth/cli) that the API does not implement, and will fail.

Check Authentication Status

apisign auth status

Logout

apisign auth logout

Template Management

List Templates

apisign template list
apisign template ls              # alias
apisign template list --json     # JSON output

Get Template Details

apisign template get TEMPLATE_ID
apisign template get TEMPLATE_ID --json
apisign template get TEMPLATE_ID -o template.html

Create Template

# Interactive mode
apisign template create -i

# From file
apisign template create -f template.html -n "My Template"

# Upload file
apisign template upload document.pdf -n "PDF Template"

Update Template

apisign template update TEMPLATE_ID -n "New Name"
apisign template update TEMPLATE_ID -f updated.html

Delete Template

apisign template delete TEMPLATE_ID
apisign template delete TEMPLATE_ID -y  # Skip confirmation

Contract Management

List Contracts

apisign contract list
apisign contract ls                          # alias
apisign contract list --status sent          # Filter by status
apisign contract list --json                 # JSON output

Status options: draft, sent, signed, cancelled

Get Contract Details

apisign contract get CONTRACT_ID
apisign contract get CONTRACT_ID --json
apisign contract get CONTRACT_ID -o contract.pdf

Create Contract

# Interactive mode
apisign contract create -i

# From template
apisign contract create -t TEMPLATE_ID -n "Contract Name"

Send Contract for Signing

# Single signer
apisign contract send CONTRACT_ID -e [email protected]

# Multiple signers
apisign contract send CONTRACT_ID -e [email protected] [email protected]

# With custom message
apisign contract send CONTRACT_ID -e [email protected] -m "Please sign by Friday"

Cancel Contract

apisign contract cancel CONTRACT_ID
apisign contract cancel CONTRACT_ID -r "Changed requirements"

Delete Contract

apisign contract delete CONTRACT_ID
apisign contract delete CONTRACT_ID -y  # Skip confirmation

View Audit Logs

apisign contract logs CONTRACT_ID
apisign contract logs CONTRACT_ID --json

Configuration

View Configuration

apisign config
apisign config --json

Configuration File Location

The CLI stores configuration in ~/.apisign/config.json

Environment Variables

• APISIGN_API_URL - Override the API URL (default: https://apisign.io)

Development

Install Dependencies

bun install

Run in Development

bun run dev

Build

bun run build              # Build for Node.js
bun run build:standalone   # Build standalone executable

Link for Local Testing

bun run link:local

Publishing

The package is configured for public npm publishing:

npm publish

License

MIT