clixaw
A command-line interface tool that translates natural language queries into executable shell commands using the cmd.xaw.me API.
Installation
From PyPI (when published)
pip install clixaw
From source
git clone <repository-url>
cd clixawtest
pip install -e .
Development mode
pip install -e ".[dev]"
Usage
Basic Usage
Translate a natural language query to a shell command:
xaw show me big files
# Output: du -ah . | sort -rh | head -n 10
Quoted Queries
For multi-word queries with special characters, use quotes:
xaw "git push new branch"
# Output: git push -u origin $(git branch --show-current)
Execute Commands
Use the --execute or -e flag to execute the translated command:
xaw --execute list files in current directory
# Executes: ls -la
Configuration
Set a custom API URL using the XAW_API_URL environment variable:
export XAW_API_URL="http://localhost:8000"
xaw show files
Or use the --api-url flag:
xaw --api-url http://localhost:8000 show files
Safety Features
By default, clixaw only prints commands without executing them. When using --execute:
- Dangerous commands (like
rm -rf,format, etc.) require confirmation - Use
--no-confirmto skip confirmation (use with caution)
xaw --execute remove all files
# Warning: This command may be dangerous!
# Command: rm -rf *
# Do you want to proceed? [y/N]:
Command-Line Options
Usage: xaw [OPTIONS] QUERY...
Translate natural language queries to shell commands using cmd.xaw.me API.
Options:
-e, --execute Execute the translated command instead of just printing it
--api-url TEXT API URL (defaults to XAW_API_URL env var or https://cmd.xaw.me)
--no-confirm Skip confirmation for dangerous commands (use with caution)
--version Show the version and exit
--help Show this message and exit
Examples
# Find large files
xaw show me big files
# Git operations
xaw "git push new branch"
xaw "create a new git branch"
# File operations
xaw list all python files
xaw find files modified today
# System information
xaw show disk usage
xaw check network connections
# Execute commands
xaw --execute show current directory
xaw -e "list files sorted by size"
API Details
- Base URL:
https://cmd.xaw.me(configurable) - Endpoints:
GET /?q={query}(query parameter style, preferred)GET /{query}(path-based)
- Response: Plain text shell command
- Authentication: None required
Error Handling
The tool handles various error scenarios:
- Network connection errors
- API timeouts
- HTTP errors from the API
- Invalid or empty responses
- Command execution errors
Development
Project Structure
clixaw/
├── clixaw/
│ ├── __init__.py
│ ├── cli.py # Main CLI entry point
│ └── api.py # API client module
├── pyproject.toml # Package configuration
├── README.md
└── requirements.txt
Running Tests
pytest
Code Formatting
black clixaw/
License
MIT License
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
Metadata
Release files for clixaw 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| clixaw-0.1.0.tar.gz | 6.3 kB | Without provenance | Details for clixaw-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| clixaw-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for clixaw-0.1.0-py3-none-any.whl |
Total release size: 13.6 kB
Release files / clixaw-0.1.0.tar.gz
| Download URL | clixaw-0.1.0.tar.gz |
|---|---|
| Size | 6.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4e611278a9971a3dfcd0c70198bdca17282569e856ed6c25080282f39982e32d
|
|
BLAKE2b-256 checksum How to use checksums |
e2ff56c514117ee6282cd5e82b6d03967a3ad8ea924ad42fae3c90f8532d0790
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.5
|
Release files / clixaw-0.1.0-py3-none-any.whl
| Download URL | clixaw-0.1.0-py3-none-any.whl |
|---|---|
| Size | 7.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
76484c6c0228aa06e83642e85118360ef2a2043812d1bef6b5cb2f8800a3b735
|
|
BLAKE2b-256 checksum How to use checksums |
dd225738f9316f1309b35cbacc7a6ac5d607db5d6853a5584b1c13cd1e5e9afa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.5
|
Security for clixaw 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.