Skip to content

Repository files navigation

Paper CLI (paper-cli)

Official Command Line Interface for Managing and Debugging the Paper AI Ecosystem.

paper-cli is the TypeScript developer CLI (@artificialpaper/cli). It provides command-line utilities for starting local development services, monitoring system health, testing gRPC endpoints, streaming logs, and inspecting active call sessions.


Installation

Install globally using npm or pnpm:

npm install -g @artificialpaper/cli

Or run via npx:

npx @artificialpaper/cli --help

Core Commands

1. paper start

Starts all ecosystem microservices locally via Docker Compose or process manager.

paper start --env development

2. paper status

Checks system health and displays status for paper-core, paper-caller, paper-memory, Redis, and ChromaDB.

paper status

3. paper test

Executes end-to-end synthetic voice tests or gRPC ping benchmarks.

# Test paper-core gRPC endpoint
paper test core --host localhost:50051

# Test WebSocket audio stream echo
paper test voice --url ws://localhost:8000/ws/audio

4. paper logs

Tail aggregated JSON logs across services with formatting and level filters.

paper logs --service paper-caller --level error

Repository Structure

paper-cli/
├── src/
│   ├── index.ts                 # CLI entry point (Commander.js)
│   ├── commands/                # Subcommand handlers (start, status, test, logs)
│   ├── client/                  # gRPC & REST client helpers
│   └── utils/                   # Terminal formatting & table renderers
├── tests/                       # Jest test suite
├── package.json                 # Node package configuration
├── tsconfig.json                # TypeScript compiler config
└── README.md

Local Development

# Clone repository
git clone https://github.com/artificialpaper/paper-cli.git
cd paper-cli

# Install dependencies
npm install

# Build TypeScript source
npm run build

# Link CLI globally for local testing
npm link

Related Repositories


License

This project is licensed under the MIT License - see the LICENSE file for details.

About

generate code, images, files, text, and speech using paper.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages