Skip to main content

Terminal in natural language. Just say what you want.

Project description

pls

Just say what you want. In your terminal.

InstallUsageProvidersConfig

PyPI Python License

pls demo

$ pls "compress all PNGs in this folder"

╭───────────────────────────────────────────────────────────╮
│ find . -name "*.png" -exec pngquant --quality=65-80 {} \; │
╰───────────────────────────────────────────────────────────╯

 Run it? (Y/n)

✓ Done.

Install

pip install pls-sh

That's it. The command is pls.

Usage

pls "find files bigger than 100MB"
pls "kill whatever is using port 3000"
pls "convert video.mp4 to gif"
pls "show disk usage sorted by size"
pls "rename all .jpeg files to .jpg"

Works offline by default with Ollama. No API key, no internet, no telemetry.

Flags

pls "do something" --explain    # also explains what the command does
pls "do something" --yes        # skip confirmation, just run it
pls "do something" --provider openai  # use a different LLM
pls "do something" --model gpt-4o    # pick a specific model

Safety

pls flags dangerous commands before running them. Stuff like rm -rf, chmod 777, dd, piping random scripts into bash — all gets highlighted in red with a warning. Dangerous commands flip the confirmation to opt-in (y/N instead of Y/n).

Providers

Ollama is the default. Runs locally, no account needed.

# make sure ollama is running
ollama serve
ollama pull llama3.2

pls "list all docker containers"
# just works

OpenAI and Anthropic if you want cloud models:

# either set env vars
export OPENAI_API_KEY=sk-...
export ANTHROPIC_API_KEY=sk-ant-...

# or save them in config
pls config set openai api_key sk-...
pls config set anthropic api_key sk-ant-...

# then use them
pls "do something" --provider openai
pls "do something" --provider anthropic

# or set a default
pls config set default provider anthropic

Config

Config lives in ~/.config/pls/config.toml.

pls config show          # see current config
pls config set ...       # change a value
pls config reset         # back to defaults

How it works

  1. You type what you want in plain English (or any language, really)
  2. pls grabs context — your OS, shell, what's in the current directory
  3. Sends that + your request to the LLM
  4. Shows you the command, asks for confirmation
  5. Runs it

No history stored, no data sent anywhere (unless you use OpenAI/Anthropic).

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

pls_sh-0.1.1.tar.gz (211.0 kB view details)

Uploaded Source

Built Distribution

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

pls_sh-0.1.1-py3-none-any.whl (14.6 kB view details)

Uploaded Python 3

File details

Details for the file pls_sh-0.1.1.tar.gz.

File metadata

  • Download URL: pls_sh-0.1.1.tar.gz
  • Upload date:
  • Size: 211.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for pls_sh-0.1.1.tar.gz
Algorithm Hash digest
SHA256 20509b2a9a521568916087e2935feb51f665c7e5ca92f857e756fffc3822331e
MD5 2bd3007f02018e398244f7642c0da5cb
BLAKE2b-256 81f14f8a9e48e60175899bd70e709ad2c9dea150df22e3e73070e834aeab5718

See more details on using hashes here.

File details

Details for the file pls_sh-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: pls_sh-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 14.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for pls_sh-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7a69e959583127cd27778674c631fd15472e9597cae14878044df6876a3ac283
MD5 586bb344e32aa3bf0804a0423fb2b27e
BLAKE2b-256 0940a40f814d7cd9c0425eec57cd7a6cfc132e32c1993e376f90777d527d9780

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