Skip to main content

A fancy CLI of Tok2Me.

Project description

tok2me

/ʤiː piː tiː miː/

WebsiteDocumentation

🚀 Getting Started

Install with pipx:

# requires Python 3.10+
pipx install tok2me-python

Now, to get started, run:

tok2me

Here are some examples:

tok2me 'write an impressive and colorful particle effect using three.js to particles.html'
tok2me 'render mandelbrot set to mandelbrot.png'
tok2me 'suggest improvements to my vimrc'
tok2me 'convert to h265 and adjust the volume' video.mp4
git diff | tok2me 'complete the TODOs in this diff'
make test | tok2me 'fix the failing tests'

🛠 Usage

$ tok2me --help
Usage: tok2me [OPTIONS] [PROMPTS]...

  tok2me is a chat-CLI for LLMs, empowering them with tools to run shell
  commands, execute code, read and manipulate files, and more.

  If PROMPTS are provided, a new conversation will be started with it. PROMPTS
  can be chained with the '-' separator.

  The interface provides user commands that can be used to interact with the
  system.

  Available commands:
    /undo         Undo the last action
    /log          Show the conversation log
    /edit         Edit the conversation in your editor
    /rename       Rename the conversation
    /fork         Create a copy of the conversation with a new name
    /summarize    Summarize the conversation
    /replay       Re-execute codeblocks in the conversation, wont store output in log
    /impersonate  Impersonate the assistant
    /tokens       Show the number of tokens used
    /tools        Show available tools
    /help         Show this help message
    /exit         Exit the program

Options:
  -n, --name TEXT        Name of conversation. Defaults to generating a random
                         name.
  -m, --model TEXT       Model to use, e.g. openai/gpt-4o,
                         anthropic/claude-3-5-sonnet-20240620. If only
                         provider given, a default is used.
  -w, --workspace TEXT   Path to workspace directory. Pass '@log' to create a
                         workspace in the log directory.
  -r, --resume           Load last conversation
  -y, --no-confirm       Skips all confirmation prompts.
  -n, --non-interactive  Force non-interactive mode. Implies --no-confirm.
  --system TEXT          System prompt. Can be 'full', 'short', or something
                         custom.
  --no-stream            Don't stream responses
  --show-hidden          Show hidden system messages.
  -v, --verbose          Show verbose output.
  --version              Show version and configuration information
  --help                 Show this message and exit.

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

tok2me_python-0.1.0.tar.gz (161.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tok2me_python-0.1.0-py3-none-any.whl (132.8 kB view details)

Uploaded Python 3

File details

Details for the file tok2me_python-0.1.0.tar.gz.

File metadata

  • Download URL: tok2me_python-0.1.0.tar.gz
  • Upload date:
  • Size: 161.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.15 Linux/6.8.0-1016-aws

File hashes

Hashes for tok2me_python-0.1.0.tar.gz
Algorithm Hash digest
SHA256 a7876e409325fcab58b22c794a2db42324b4e2b6925fa4407ad80b8d26202c87
MD5 2c18ab00503a2f449da1943572d5146c
BLAKE2b-256 82fa210c495b122e0e45a06acdbd2296800f639fb1df6189366001f0eef4e9ac

See more details on using hashes here.

File details

Details for the file tok2me_python-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: tok2me_python-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 132.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.15 Linux/6.8.0-1016-aws

File hashes

Hashes for tok2me_python-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8409877fd24365bc4358184fbd003984766ac1a3f4fdb898e374f4c921f9f7c6
MD5 7d007ce911c81b08baaf47ea8fcab27c
BLAKE2b-256 35112785a7d0c3f3e59b204639d78e6755bda8ccaa90197d748f6101b29af4d6

See more details on using hashes here.

Supported by

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