yolox 🤞

Use AI language models to write one-liner shell commands, then execute them.

Examples

$ yolox list all files in the current directory, sorted by human size
# ls -lhS

$ yolox rename all jpeg files to jpg
# for file in *.jpeg; do mv "$file" "${file%.jpeg}.jpg"; done

$ yolox extract from 0:30 to 1:22 from video.mp4 and save it as audio.m4a
# ffmpeg -i video.mp4 -ss 00:00:30 -to 00:01:22 -vn -acodec copy audio.m4a

$ yolox create slideshow.mp4 from all the jpg files in the current directory with one second for each slide
# ffmpeg -framerate 1 -pattern_type glob -i '*.jpg' slideshow.mp4

$ yolox "add 100px white padding around dots.png and save it as dots-with-room.png"
# convert dots.png -bordercolor white -border 100 dots-with-room.png

Working with Piped Data

You can pipe data to yolox and it will include that data in the context when generating commands:

$ echo '{"name": "Alice", "age": 30, "city": "NYC"}' | yolox "use jq to extract just the name"
# echo '{"name": "Alice", "age": 30, "city": "NYC"}' | jq '.name'

$ cat users.json | yolox "use jq to get all users over age 25"
# cat users.json | jq '.[] | select(.age > 25)'

$ ps aux | yolox "find processes using more than 50% CPU"
# ps aux | awk '$3 > 50'

$ curl -s https://api.github.com/users/octocat | yolox "extract the public repos count with jq"
# curl -s https://api.github.com/users/octocat | jq '.public_repos'

File-based Prompts

You can also pass a file containing the prompt. This lets you write long prompts and iterate on them without retyping:

echo "do some stuff" > PROMPT.md
$ yolox PROMPT.md

Caution

This tool should be used with caution. It's called "YOLO X" because it's dangerous. yolo as in "you only live once" and x as in "execute this code". It lets an AI write code for you, then blindly executes that code on your system. There are a few guardrails in its prompt to prevent the result from taking destructive actions like deleting files or directories, but there's always still a danger that the resulting commands will have unintended consequences. You've been warned!

Installation

npm i -g yolox

or you can just invoke it directly with npx:

npx yolox@latest "use ffmpeg to convert foo.mkv to foo.mp4"

Usage

yolox supports three input methods:

1. Direct command: yolox "command description"
2. File input: yolox filename.txt (where the file contains the command description)
3. Stdin input: echo "data" | yolox "process this data"

Command Line Options

• --model: Choose the AI model to use (default: gpt-4o)
  • gpt-4o or gpt4: Uses OpenAI's GPT-4o
  • llama, llama3, or llama31: Uses Meta's Llama models on Replicate
• --print: Show the generated command without executing it

Examples

# Basic usage
yolox "list files by size"

# Use specific model
yolox --model=llama "compress all png files"

# Print mode (don't execute)
yolox --print "find large files"

# With piped data
cat data.csv | yolox "convert to JSON using any available tools"

# Using a prompt file
echo "complex multi-line prompt here" > prompt.txt
yolox prompt.txt

yolox supports GPT4o on OpenAI and Llama 3 on Replicate.

To add support for other models or providers, open a pull request!

OpenAI Usage (GPT4o)

Set your OpenAI API key in the environment:

export OPENAI_API_KEY="..."

Then give it a command and it will execute it:

yolox "extract audio from maths.mp4 and save it as maths.m4a"
# ffmpeg -i maths.mp4 -vn -acodec copy maths.m4a

Replicate Usage (Llama 3)

Set your Replicate token in the environment:

export REPLICATE_API_TOKEN="r8_..."

Then specify model as a flag set to llama (which uses meta/meta-llama-3.1-405b-instruct):

yolox "extract audio from maths.mp4 and save it as maths.m4a" --model=llama
# ffmpeg -i maths.mp4 -vn -acodec copy maths.m4a

Print mode

Print the command but don't execute it:

yolox --print "extract audio from maths.mp4 and save it as maths.m4a"
ffmpeg -i maths.mp4 -vn -acodec copy maths.m4a

Testing

Run the test suite:

npm test

The tests cover:

• Basic functionality and argument parsing
• Stdin input handling
• Model selection and validation
• File-based prompt input
• Print mode operation
• Error handling

Alternatives

GitHub Copilot CLI is a paid offering from GitHub that works similarly to yolox, but is safer. Rather than running the generated command, it shows you the command and gives you some options:

$ gh copilot suggest -t shell "list all files"

Suggestion:

  ls -a

? Select an option  [Use arrows to move, type to filter]
> Copy command to clipboard
  Explain command
  Revise command
  Rate response
  Exit

License

MIT