Skip to main content

A command-line tool for interacting with the Anthropic API

Project description

Anthropic API Command Line Tool

This is a command line tool that allows you to interact with the Anthropic API using the Anthropic Python SDK. You can send messages, including text and images, to the API and receive responses.

NOTE: This CLI has been programmed by Claude 3

screenshot

Features

  • Send text messages to the Anthropic API
  • Include images (PNG, JPEG, or PDF) in the messages
  • Specify various parameters such as model, system message, temperature, top-k, top-p, and max tokens
  • Parse PDF files and convert into a JPEG image for processing (requires Poppler)

Installing Poppler

Poppler is a separate library that is required by the pdf2image library for converting PDF files to images. The installation process for Poppler varies depending on your operating system.

Please check https://pdf2image.readthedocs.io/en/latest/installation.html for installation instructions.

You do not need to install Poppler if you don't plan on passing PDFs into the vision API.

Setup

pip install anthropic-sdk

Set your Anthropic API key as an environment variable named ANTHROPIC_API_KEY. You can do this by running the following command in your terminal or adding it to your shell configuration file (e.g., .bashrc, .zshrc):

export ANTHROPIC_API_KEY="your_api_key_here"

Replace "your_api_key_here" with your actual Anthropic API key.

Usage

To use the command line tool, run the following command:

python anthropic_cli.py [options]

Options

  • -g, --message: Add a message with the specified role and content. You can use this option multiple times to add multiple messages. The format is -g <role> "<content>".

    • <role>: The role of the message sender, e.g., "user" or "assistant".
    • <content>: The content of the message, enclosed in double quotes.
  • -i, --image: Path to an image file to include in the message. The image should be in PNG format.

  • -m, --model: Anthropic model to use (default: "claude-3-opus-20240229").

  • -s, --system: System message to provide context or instructions to the model.

  • -t, --temperature: Temperature value for the model, controlling the randomness of the generated response.

  • -k, --top_k: Top-k sampling parameter, restricting the model to consider only the top k most likely tokens.

  • -p, --top_p: Top-p sampling parameter, restricting the model to consider only the most likely tokens whose cumulative probability exceeds p.

  • -x, --max_tokens: Maximum number of tokens in the generated response (default: 1024).

Examples

  1. Send a simple message:

    python anthropic_cli.py -g user "Hello, Claude!"
    
  2. Send multiple messages:

    python anthropic_cli.py -g user "Hello, Claude!" -g assistant "Hello! How can I assist you today?"
    
  3. Include an image in the message:

    python anthropic_cli.py -g user "What does this image show?" -i path/to/image.png
    
  4. Specify the model and other parameters:

    python anthropic_cli.py -g user "Hello, Claude!" -m claude-3-opus-20240229 -s "You are a helpful assistant." -t 0.8 -x 500
    

    This command uses the "claude-3-opus-20240229" model, sets a system message, adjusts the temperature to 0.8, and limits the maximum number of tokens in the response to 500.

Output

The command line tool will send the messages and image (if provided) to the Anthropic API and print the text content of the response to the console.

LICENSE

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

anthropic-cli-0.2.3.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

anthropic_cli-0.2.3-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

Details for the file anthropic-cli-0.2.3.tar.gz.

File metadata

  • Download URL: anthropic-cli-0.2.3.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.7

File hashes

Hashes for anthropic-cli-0.2.3.tar.gz
Algorithm Hash digest
SHA256 c0a255caf8a83d71e9047b7ab250c7ee996a0cb23766475025a56b2aa5e0a515
MD5 00237c7cccb4384a773a459360996d85
BLAKE2b-256 a877ed4ad5b23bbae8f71af6db754170c6bffbca327b80cd625a100c2b3ed092

See more details on using hashes here.

File details

Details for the file anthropic_cli-0.2.3-py3-none-any.whl.

File metadata

File hashes

Hashes for anthropic_cli-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 510f4366fa9e0ab24580940c87bf8783c145895d091e82d6e47e3ada8cd629fa
MD5 2094bffcb66f0fad527f70f579368da6
BLAKE2b-256 bdb765f886b04254db8f9a63c68556219b8bce0fa27b72fb2dcc97d75632f455

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page