cli

ToneClone CLI

A powerful command-line interface for ToneClone, the AI-powered writing assistance platform. Generate text, manage personas, configure profiles, and streamline your writing workflow from the terminal.

Table of Contents

• Installation
• Quick Start
• Authentication
• Core Commands
• Configuration
• Shell Completion
• Examples
• Troubleshooting

Installation

Build from Source

# Clone the repository
git clone https://github.com/toneclone/cli.git
cd cli

# Build the CLI
make build

# Install to your PATH (optional)
sudo cp bin/toneclone /usr/local/bin/

Verify Installation

toneclone --version
toneclone --help

Quick Start

1. Login with your API key:

   toneclone auth login
   

2. Check your account:

   toneclone user whoami
   

3. Generate your first text:

   toneclone write --persona="Professional" --prompt="Write a professional email about project updates"
   

4. List available personas:

   toneclone personas list
   

Authentication

Login with API Key

# Interactive login
toneclone auth login

# Or provide API key directly
toneclone auth login --key="your-api-key" --name="work"

Manage API Keys

# List configured keys
toneclone auth list

# Switch between keys
toneclone auth use work

# Check current key
toneclone auth current

# Logout (remove key)
toneclone auth logout

Environment Variables

# Set API key via environment variable
export TONECLONE_API_KEY="your-api-key"
export TONECLONE_BASE_URL="https://api.toneclone.ai"

# Use with CLI
toneclone write --persona="Professional" --prompt="Hello world"

Core Commands

Text Generation

# Basic text generation
toneclone write --persona="Professional" --prompt="Write a blog post about AI"

# With persona
toneclone write --persona="Professional" --prompt="Draft a proposal"

# With profile
toneclone write --persona="Professional" --profile="Email Template" --prompt="Write an email"

# Interactive mode (will prompt for input)
toneclone write --persona="Casual"

# Streaming output
toneclone write --persona="Creative" --prompt="Long story"

# Save to file
toneclone write --persona="Professional" --prompt="Content" > result.txt

Persona Management

# List all personas
toneclone personas list

# Get persona details
toneclone personas get "Technical Writer"

# Create new persona
toneclone personas create --name="Technical Writer"

# Interactive creation
toneclone personas create --interactive

# Update persona
toneclone personas update "Technical Writer" --name="New Name"

# Delete persona
toneclone personas delete "Technical Writer" --confirm

Profile Management

# List profiles
toneclone profiles list

# Get profile details
toneclone profiles get "Email Template"

# Create profile
toneclone profiles create --name="Email Template" --instructions="Write professional emails"

# Update profile
toneclone profiles update "Email Template" --name="New Name"

# Append to instructions
toneclone profiles update "Email Template" --append=" Include examples."

# Associate with persona
toneclone profiles associate --profile="Email Template" --persona="Professional"

# Delete profile
toneclone profiles delete "Email Template" --confirm

Training Data Management

# List training files
toneclone training list

# Upload text content
toneclone training add --text="Sample content" --filename="sample.txt" --persona="Writer"

# Upload file
toneclone training add --file="document.pdf" --persona="Professional"

# Bulk upload directory
toneclone training add --directory="./docs" --recursive --persona="Technical"

# Associate file with persona
toneclone training associate --file-id=123 --persona="Professional"

# Remove training file
toneclone training remove --file-id=123 --confirm

Configuration

Configuration Management

# Show current configuration
toneclone config show

# List API keys
toneclone config list

# Validate configuration
toneclone config validate

# Show config file path
toneclone config path

# Initialize new config
toneclone config init

Configuration File

The CLI uses a YAML configuration file located at ~/.toneclone.yaml:

default_key: "work"
keys:
  work:
    key: "tc_live_..."
    base_url: "https://api.toneclone.ai"
  personal:
    key: "tc_live_..."
    base_url: "https://api.toneclone.ai"

Environment Variables

Shell Completion

Install Completion

# Bash
toneclone completion bash > /etc/bash_completion.d/toneclone

# Zsh
toneclone completion zsh > "${fpath[1]}/_toneclone"

# Fish
toneclone completion fish > ~/.config/fish/completions/toneclone.fish

# PowerShell
toneclone completion powershell > toneclone.ps1

Quick Setup

# Test completion without installing
source <(toneclone completion bash)     # Bash
toneclone completion fish | source      # Fish
toneclone completion zsh | source /dev/stdin  # Zsh

User Management

# Check current user
toneclone user whoami

# Detailed user info
toneclone user info

# View user settings
toneclone user settings

Health & Diagnostics

# Quick ping test
toneclone ping

# Basic health check
toneclone health

# Comprehensive status
toneclone health status

# JSON output
toneclone health --format=json

Examples

Daily Workflow

# Morning routine
toneclone auth current
toneclone health
toneclone personas list

# Generate content
toneclone write --persona="Professional" --profile="Email" --prompt="Write a project status update"

# Save to file
toneclone write --persona="Professional" --prompt="Weekly report content" > report.md

Content Creation

# Blog post
toneclone write --persona="Tech Writer" --profile="Blog Post" --prompt="AI trends in 2024"

# Email campaigns
toneclone write --persona="Marketing" --profile="Email Campaign" --prompt="Newsletter content"

# Documentation
toneclone write --persona="Technical" --profile="Documentation" --prompt="API documentation for users endpoint"

Persona Setup

# Create specialized personas
toneclone personas create --name="Social Media Manager"

toneclone personas create --name="Technical Writer"

# Create matching profiles
toneclone profiles create \
  --name="Twitter Post" \
  --instructions="Write engaging Twitter posts under 280 characters"

toneclone profiles create \
  --name="Documentation" \
  --instructions="Write clear, concise technical documentation with examples"

Training Data Management

# Upload training materials
toneclone training add --file="brand-guidelines.pdf" --persona="Marketing"
toneclone training add --directory="./docs" --recursive --persona="Technical"

# Manage file associations
toneclone training associate --file-id=456 --persona="Professional"

Output Formats

Most commands support multiple output formats:

# Table format (default)
toneclone personas list

# JSON format
toneclone personas list --format=json

Global Flags

Troubleshooting

Common Issues

Authentication errors:

# Check current authentication
toneclone auth current

# Validate API key
toneclone auth status

# Re-login if needed
toneclone auth login

Connection issues:

# Test connectivity
toneclone ping

# Check service health
toneclone health status

# Validate configuration
toneclone config validate

Configuration problems:

# Show current config
toneclone config show

# Check config file location
toneclone config path

# Reinitialize config
toneclone config init

Debug Mode

# Enable debug output
toneclone --debug write --persona="Professional" --prompt="test"

# Verbose mode
toneclone --verbose personas list

Getting Help

# General help
toneclone --help

# Command-specific help
toneclone write --help
toneclone personas create --help

# List all commands
toneclone --help

Advanced Usage

Scripting

#!/bin/bash
# Batch content generation

# Check authentication
if ! toneclone auth current &>/dev/null; then
    echo "Please login: toneclone auth login"
    exit 1
fi

# Generate multiple pieces
toneclone write --persona="Professional" --prompt="Blog post about AI" > blog-ai.md
toneclone write --persona="Creative" --prompt="Social media post" > social-ai.txt
toneclone write --persona="Marketing" --prompt="Email newsletter" > newsletter.html

echo "Content generation complete!"

CI/CD Integration

# Use environment variables for CI/CD
export TONECLONE_API_KEY="$SECRET_API_KEY"

# Generate content in pipeline
toneclone write --persona="Technical" --prompt="Release notes for v1.2.0" > release-notes.md

# Validate configuration
toneclone config validate

Profile Management

# Create profiles for different use cases
toneclone profiles create --name="Email" --instructions="Professional email format"
toneclone profiles create --name="Blog" --instructions="Engaging blog post style"
toneclone profiles create --name="Documentation" --instructions="Clear technical writing"

# Associate profiles with personas
toneclone profiles associate --profile="Email" --persona="Professional"
toneclone profiles associate --profile="Blog Post" --persona="Creative"

Support

• Documentation: docs.toneclone.com
• GitHub Issues: github.com/toneclone/cli/issues
• Support: support@toneclone.com

License

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