SmartyPants CLI Tool

Welcome to SmartyPants, a user-friendly CLI tool for interacting with AI services, featuring a powerful command and plugin system!

Contents

  1. Setup
  2. Usage
  3. Commands
  4. References

Setup

Requirements

no requirements specified

Installation

Homebrew

brew install smartypants-cli

NPM

npm install -g smartypants-cli

PIP

pip install smartpants-cli

Usage

smartypants <plugin_name> <plugin_command> [arguments] [options]

Commands

OpenAI

Adds support for OpenAI interaction

Usage: smartypants openai <command> [arguments] [options]

Commands

chat | An interactive session with OpenAI

Usage: smartypants openai chat

Arguments

None

Options

None


draw | Draw an image based on description

Usage: smartypants openai draw <arguments> [options]

Arguments

image_description (string) : Description of what to draw

Options

browser (boolean) : Opens image in a new browser tab

size (integer) (Default: 256) : Size of the image in pixels

Allowed Values: 256, 512, 1024


models | List available models

Usage: smartypants openai models

Arguments

None

Options

None

Examples

List available models in OpenAI

smartypants openai models

prompts | Preconfigured prompt to use with chats

Usage: smartypants openai prompts

Arguments

None

Options

None


send | Send one or more messages to OpenAI

Usage: smartypants openai send [options]

Arguments

None

Options

attach (String) : File to include as message

Format: filepath

live (Boolean) : Stream the response as it is received

message (String) : Message to send

model (String) (Default: gpt-3.5-turbo) : Language model to use

Allowed Values: gpt-3.5-turbo, gpt-4, gpt-3.5-turbo-0613, gpt-3.5-turbo-16k, gpt-4-0613

raw (Boolean) : Don't format the response

Examples

Send one or more messages to OpenAI

smartypants openai send --message 'Hello OpenAI' --model 'gpt-3.5-turbo'

Plugins

Adds support for managing plugins

Usage: smartypants plugins <command> [arguments] [options]

Commands

disable | Disables a plugin

Usage: smartypants plugins disable <arguments>

Arguments

plugin (Required) : Name of plugin

Options

None

Examples

Disable a plugin

smartypants plugins disable openai

enable | Enables a plugin

Usage: smartypants plugins enable <arguments>

Arguments

plugin (Required) : Name of plugin

Options

None

Examples

Enable a plugin

smartypants plugins enable openai

install | Installs a plugin

Usage: smartypants plugins install <arguments>

Arguments

plugin (Required) : Name of plugin

Options

None

Examples

Install a plugin

smartypants plugins install openai

list | Lists all installed plugins

Usage: smartypants plugins list

Arguments

None

Options

None

Examples

List all installed plugins

smartypants plugins list

uninstall | Uninstalls a plugin

Usage: smartypants plugins uninstall <arguments>

Arguments

plugin (Required) : Name of plugin

Options

None

Examples

Uninstall a plugin

smartypants plugins uninstall openai

update | Updates a plugin

Usage: smartypants plugins update <arguments>

Arguments

plugin : Name of plugin

Options

None

Examples

Update a plugin

smartypants plugins update openai

status | Shows state of a specific plugin

Usage: smartypants plugins status <arguments>

Arguments

plugin (Required) : Name of plugin

Options

None

Examples

Show status of a plugin

smartypants plugins status openai

Contributor Guidelines

Licenses and Legal

References

Formats

Format Definition Examples
filepath A valid Mac, Linux, or Windows filepath ./some/directory/, /home/user/file.txt