Tickerterm CLI

A command line interface for TickerBot operations.

Setup

1. Navigate to the CLI directory:

   cd cli

2. Install dependencies:

   npm install

3. Link the CLI globally for development:

   npm link

After linking, you can use tickerterm from anywhere in your terminal.

Usage

Demo Command

Run the demo command to test the CLI:

tickerterm demo

Development

Local Testing

You can run the CLI locally without global installation:

npm run dev demo

Installing from Source

To install globally:

npm install -g .

Uninstalling

To remove the global installation:

npm uninstall -g tickerterm

Future Distribution

This CLI is designed to be distributed via Homebrew. The package structure supports global installation and follows Node.js CLI best practices.

Commands

Authentication

• tickerterm login --email - Login with email and password (default: production)
• tickerterm login --google - Login with Google OAuth (opens browser)
• tickerterm login --email --staging - Login to staging (internal emails only)
• tickerterm login --google --staging - Google OAuth to staging (internal emails only)
• tickerterm logout - Logout and clear stored credentials
• tickerterm whoami - Show current authentication status

General

• tickerterm demo - Runs a demonstration command
• More commands will be added as the tool evolves

Authentication

All TickerBot operations require authentication. The CLI supports two login methods:

1. Email/Password: Secure terminal prompts
2. Google OAuth: Browser-based authentication

Environment Access

• Production: Default environment for all users
• Staging: Only available for @tickerterm.com and @tickerbot.io email addresses

Token Storage

• Credentials are securely stored in ~/.tickerterm/auth.json with restricted file permissions (600)
• Tokens are valid for 1 hour and automatically refresh when needed
• No manual re-authentication required unless refresh token expires

Requirements

• Node.js >= 14.0.0