axle-cli 1.2.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- axle_cli-1.2.0/LICENSE +21 -0
- axle_cli-1.2.0/PKG-INFO +275 -0
- axle_cli-1.2.0/README.md +244 -0
- axle_cli-1.2.0/axle/__init__.py +1 -0
- axle_cli-1.2.0/axle/axle.py +1350 -0
- axle_cli-1.2.0/axle/code_reviewer.py +655 -0
- axle_cli-1.2.0/axle/config.py +137 -0
- axle_cli-1.2.0/axle/install_axle.py +436 -0
- axle_cli-1.2.0/axle/security_scan.py +358 -0
- axle_cli-1.2.0/axle/tool_metadata.py +599 -0
- axle_cli-1.2.0/axle/tool_validator.py +317 -0
- axle_cli-1.2.0/axle_cli.egg-info/PKG-INFO +275 -0
- axle_cli-1.2.0/axle_cli.egg-info/SOURCES.txt +33 -0
- axle_cli-1.2.0/axle_cli.egg-info/dependency_links.txt +1 -0
- axle_cli-1.2.0/axle_cli.egg-info/entry_points.txt +2 -0
- axle_cli-1.2.0/axle_cli.egg-info/requires.txt +10 -0
- axle_cli-1.2.0/axle_cli.egg-info/top_level.txt +5 -0
- axle_cli-1.2.0/docs/CODE_REVIEW.md +388 -0
- axle_cli-1.2.0/docs/changelog.md +336 -0
- axle_cli-1.2.0/docs/commands.md +453 -0
- axle_cli-1.2.0/docs/contributing.md +435 -0
- axle_cli-1.2.0/docs/index.md +77 -0
- axle_cli-1.2.0/docs/installation.md +279 -0
- axle_cli-1.2.0/docs/pypi-guide.md +349 -0
- axle_cli-1.2.0/docs/security.md +347 -0
- axle_cli-1.2.0/docs/troubleshooting.md +435 -0
- axle_cli-1.2.0/docs/usage.md +383 -0
- axle_cli-1.2.0/pyproject.toml +50 -0
- axle_cli-1.2.0/setup.cfg +4 -0
- axle_cli-1.2.0/tools/01_seo_keyword_checker.py +291 -0
- axle_cli-1.2.0/tools/02_meta_tag_auditor.py +361 -0
- axle_cli-1.2.0/tools/03_daily_life_hack_generator.py +447 -0
- axle_cli-1.2.0/tools/__init__.py +1 -0
- axle_cli-1.2.0/website/CLOUDFLARE_DEPLOYMENT.md +192 -0
- axle_cli-1.2.0/website/README.md +114 -0
axle_cli-1.2.0/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Sanjoy K. Paul
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
axle_cli-1.2.0/PKG-INFO
ADDED
|
@@ -0,0 +1,275 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: axle-cli
|
|
3
|
+
Version: 1.2.0
|
|
4
|
+
Summary: A modular CLI platform for running Python microtools from a shared tools directory.
|
|
5
|
+
Author-email: "Sanjoy K. Paul" <hello@skpaul.me>
|
|
6
|
+
License: MIT
|
|
7
|
+
Classifier: Development Status :: 3 - Alpha
|
|
8
|
+
Classifier: Environment :: Console
|
|
9
|
+
Classifier: Intended Audience :: Developers
|
|
10
|
+
Classifier: Intended Audience :: Information Technology
|
|
11
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
12
|
+
Classifier: Natural Language :: English
|
|
13
|
+
Classifier: Operating System :: OS Independent
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
17
|
+
Requires-Python: >=3.10
|
|
18
|
+
Description-Content-Type: text/markdown
|
|
19
|
+
License-File: LICENSE
|
|
20
|
+
Requires-Dist: pandas>=1.5.0
|
|
21
|
+
Requires-Dist: openpyxl>=3.0.0
|
|
22
|
+
Requires-Dist: scikit-learn>=1.2.0
|
|
23
|
+
Requires-Dist: spacy>=3.5.0
|
|
24
|
+
Requires-Dist: sentence-transformers>=2.2.0
|
|
25
|
+
Requires-Dist: beautifulsoup4>=4.12.0
|
|
26
|
+
Requires-Dist: requests>=2.28.0
|
|
27
|
+
Requires-Dist: nltk>=3.8.0
|
|
28
|
+
Requires-Dist: numpy>=1.23.0
|
|
29
|
+
Requires-Dist: lxml>=4.9.0
|
|
30
|
+
Dynamic: license-file
|
|
31
|
+
|
|
32
|
+
# Axle v1.2.0
|
|
33
|
+
|
|
34
|
+
A modular CLI platform for running Python microtools from a shared tools directory.
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## 🚀 Quick install
|
|
39
|
+
|
|
40
|
+
### Method 1: Install from GitHub (Recommended)
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
pip install git+https://github.com/skpaul82/axle-cli.git
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
That's it! You can now run:
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
axle list
|
|
50
|
+
axle run 1 "your prompt"
|
|
51
|
+
axle scan
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### Method 2: Manual Installation
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
# Clone the repository
|
|
58
|
+
git clone https://github.com/skpaul82/axle-cli.git
|
|
59
|
+
cd axle-cli
|
|
60
|
+
|
|
61
|
+
# Install dependencies
|
|
62
|
+
pip install --upgrade pip
|
|
63
|
+
pip install -r requirements.txt
|
|
64
|
+
|
|
65
|
+
# Install the package
|
|
66
|
+
pip install -e .
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
> **Note**: PyPI installation (`pip install axle-cli`) is planned for future releases. For v1.2.0, please use the GitHub installation method above.
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
## 🎉 What's New in v1.2.0
|
|
74
|
+
|
|
75
|
+
### ✨ Optional Security & Code Review
|
|
76
|
+
- **Security and code review are now DISABLED by default** for faster execution
|
|
77
|
+
- Use `--security` and `--code-review` flags to enable per-run
|
|
78
|
+
- Use `axle security enable` and `axle review enable` to enable persistently
|
|
79
|
+
- Configuration stored in `~/.axle/config.json`
|
|
80
|
+
|
|
81
|
+
### 🔄 Built-in Update Command
|
|
82
|
+
- **`axle update`** - Update Axle CLI to the latest version
|
|
83
|
+
- **`axle update --check`** - Check for updates without installing
|
|
84
|
+
- Automatic dependency updates and package reinstallation
|
|
85
|
+
|
|
86
|
+
### 📊 Tool Metadata System
|
|
87
|
+
- **`axle metadata scan`** - Scan all tools and build metadata cache
|
|
88
|
+
- **`axle metadata show <tool>`** - Show detailed tool information
|
|
89
|
+
- **`axle metadata search <query>`** - Search tools by name, functions, or description
|
|
90
|
+
- **`axle metadata list`** - List all tools with summaries
|
|
91
|
+
- View tool functions, parameters, documentation, and imports
|
|
92
|
+
|
|
93
|
+
### 📚 Improved Documentation
|
|
94
|
+
- Updated command reference with all new commands
|
|
95
|
+
- Better inline help and error messages
|
|
96
|
+
- Enhanced user experience
|
|
97
|
+
|
|
98
|
+
---
|
|
99
|
+
|
|
100
|
+
## 📦 Features
|
|
101
|
+
|
|
102
|
+
### 🔒 Built-in Security (Optional)
|
|
103
|
+
|
|
104
|
+
- **Pre-execution validation**: Tools can be scanned for security issues before running (optional)
|
|
105
|
+
- **Dangerous pattern detection**: Blocks eval(), exec(), shell=True, and more
|
|
106
|
+
- **Hardcoded secret detection**: Finds passwords, API keys, tokens in code
|
|
107
|
+
- **Configurable security policies**: strict, warn, permissive modes
|
|
108
|
+
- **On-demand validation**: Enable per-run with `--security` flag or persistently with `axle security enable`
|
|
109
|
+
- **Dependency vulnerability scanning**: Integrated pip-audit for package security
|
|
110
|
+
|
|
111
|
+
### 🔍 Automatic Code Review (Optional)
|
|
112
|
+
|
|
113
|
+
- **Pre-execution code quality checks**: Automatic review before running tools (optional)
|
|
114
|
+
- **Auto-fixing**: Fixes formatting (Black) and import sorting (isort) issues
|
|
115
|
+
- **Clear feedback**: Shows exactly what's wrong and how to fix it
|
|
116
|
+
- **Non-blocking**: Won't stop your workflow by default
|
|
117
|
+
- **Manual review**: Run `axle review` anytime for comprehensive checks
|
|
118
|
+
- **CI/CD integration**: Catch issues locally before they reach CI
|
|
119
|
+
- **On-demand review**: Enable per-run with `--code-review` flag or persistently with `axle review enable`
|
|
120
|
+
|
|
121
|
+
### Core Features
|
|
122
|
+
|
|
123
|
+
- Modular platform for running ANY Python tool consistently
|
|
124
|
+
- SEO-focused microtools (keyword checker, meta-tag auditor, etc.)
|
|
125
|
+
- Daily-life automation helpers from the terminal
|
|
126
|
+
- `axle list` shows all tools with numbers
|
|
127
|
+
- `axle run <tool_number_or_name> <prompt>` executes a tool
|
|
128
|
+
- Configurable tools folder path
|
|
129
|
+
|
|
130
|
+
---
|
|
131
|
+
|
|
132
|
+
## 🛠️ Commands
|
|
133
|
+
|
|
134
|
+
| Command | Purpose |
|
|
135
|
+
| -------------------------- | -------------------------------------------- |
|
|
136
|
+
| `axle -V, --version` | Show Axle version. |
|
|
137
|
+
| `axle list` | List all tools in the `tools/` directory. |
|
|
138
|
+
| `axle run 1 "prompt"` | Run tool by number and pass a prompt. |
|
|
139
|
+
| `axle run tool_name ...`| Run by filename (without `.py`). |
|
|
140
|
+
| `axle run 1 "prompt" --security` | Run tool with security validation enabled. |
|
|
141
|
+
| `axle run 1 "prompt" --code-review` | Run tool with code review enabled. |
|
|
142
|
+
| `axle info tool_name` | Show tool description. |
|
|
143
|
+
| `axle scan` | Scan dependencies for known vulnerabilities. |
|
|
144
|
+
| `axle doctor` | Check Python, disk, and required modules. |
|
|
145
|
+
| `axle path` | Show current tools folder location. |
|
|
146
|
+
| `axle review <tool>` | Run code review on a specific tool. |
|
|
147
|
+
| `axle review --all` | Run code review on all tools. |
|
|
148
|
+
| `axle review --fix` | Apply automatic fixes to issues found. |
|
|
149
|
+
| `axle review --enable` | Enable code review by default. |
|
|
150
|
+
| `axle review --disable` | Disable code review by default. |
|
|
151
|
+
| `axle review --show` | Show current code review configuration. |
|
|
152
|
+
| `axle security` | Show or configure security policy. |
|
|
153
|
+
| `axle security --enable` | Enable security validation by default. |
|
|
154
|
+
| `axle security --disable` | Disable security validation by default. |
|
|
155
|
+
| `axle security --show` | Show current security configuration. |
|
|
156
|
+
| `axle update` | Update Axle CLI to the latest version. |
|
|
157
|
+
| `axle update --check` | Check for updates without installing. |
|
|
158
|
+
| `axle metadata scan` | Scan tools and build metadata cache. |
|
|
159
|
+
| `axle metadata show <tool>` | Show detailed metadata for a tool. |
|
|
160
|
+
| `axle metadata search <query>` | Search tools by name, functions, etc. |
|
|
161
|
+
| `axle metadata list` | List all tools with summaries. |
|
|
162
|
+
| `axle help` | Show all commands. |
|
|
163
|
+
|
|
164
|
+
---
|
|
165
|
+
|
|
166
|
+
## 🧱 Requirements
|
|
167
|
+
|
|
168
|
+
- Python 3.10+
|
|
169
|
+
- RAM: 8 GB minimum, 16 GB preferred
|
|
170
|
+
- Disk: 5–8 GB free for models and caches
|
|
171
|
+
- CPU: 2 cores minimum, 4 cores preferred
|
|
172
|
+
|
|
173
|
+
Install via `pip install -r requirements.txt` and `pip install -e .`
|
|
174
|
+
|
|
175
|
+
---
|
|
176
|
+
|
|
177
|
+
## 📝 Docs
|
|
178
|
+
|
|
179
|
+
See:
|
|
180
|
+
|
|
181
|
+
- `docs/index.md` – overview
|
|
182
|
+
- `docs/security.md` – **security validation (MANDATORY)**
|
|
183
|
+
- `docs/installation.md` – step-by-step setup
|
|
184
|
+
- `docs/usage.md` – how to use tools
|
|
185
|
+
- `docs/commands.md` – detailed command reference
|
|
186
|
+
|
|
187
|
+
---
|
|
188
|
+
|
|
189
|
+
## 🔧 Adding Your Own Tools
|
|
190
|
+
|
|
191
|
+
Axle is designed as a platform for tools - you can easily add your own Python scripts!
|
|
192
|
+
|
|
193
|
+
### Tools Directory
|
|
194
|
+
|
|
195
|
+
Run `axle path` to see your tools directory location. By default, it's created at:
|
|
196
|
+
|
|
197
|
+
```
|
|
198
|
+
<axle_install_location>/tools/
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
### How to Add Tools
|
|
202
|
+
|
|
203
|
+
1. **Find your tools directory**:
|
|
204
|
+
|
|
205
|
+
```bash
|
|
206
|
+
axle path
|
|
207
|
+
```
|
|
208
|
+
2. **Create a new Python file** in the tools directory:
|
|
209
|
+
|
|
210
|
+
```bash
|
|
211
|
+
# Example: tools/04_my_tool.py
|
|
212
|
+
```
|
|
213
|
+
3. **Implement the required functions**:
|
|
214
|
+
|
|
215
|
+
```python
|
|
216
|
+
def get_description() -> str:
|
|
217
|
+
"""Return one-line description of the tool."""
|
|
218
|
+
return "Brief description of what your tool does"
|
|
219
|
+
|
|
220
|
+
def main(prompt: str) -> None:
|
|
221
|
+
"""Main entry point. Called by CLI router."""
|
|
222
|
+
# Your tool logic here
|
|
223
|
+
print(f"Processing: {prompt}")
|
|
224
|
+
```
|
|
225
|
+
4. **Run your tool**:
|
|
226
|
+
|
|
227
|
+
```bash
|
|
228
|
+
axle list # Your tool appears in the list
|
|
229
|
+
axle run 4 "your prompt" # Run by number
|
|
230
|
+
axle run my_tool "your prompt" # Run by name
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
### Tool Requirements
|
|
234
|
+
|
|
235
|
+
- ✅ Must implement `get_description()` function (returns string)
|
|
236
|
+
- ✅ Must implement `main(prompt: str)` function (no return value)
|
|
237
|
+
- ✅ File must be valid Python 3.10+
|
|
238
|
+
- ✅ Optional: Use numeric prefix for ordering (e.g., `04_my_tool.py`)
|
|
239
|
+
|
|
240
|
+
**Learn more**: [www.axle.sanjoypaul.com](https://www.axle.sanjoypaul.com)
|
|
241
|
+
|
|
242
|
+
---
|
|
243
|
+
|
|
244
|
+
## 🌐 Community & Support
|
|
245
|
+
|
|
246
|
+
If this helps your workflow:
|
|
247
|
+
|
|
248
|
+
- ⭐ **Star on GitHub**: [skpaul82/axle-cli](https://github.com/skpaul82/axle-cli)
|
|
249
|
+
- 🐦 **Follow on X**: [@_skpaul82](https://x.com/_skpaul82)
|
|
250
|
+
- 🌐 **Website**: [www.axle.sanjoypaul.com](https://www.axle.sanjoypaul.com)
|
|
251
|
+
- 🌐 ***FB Group***: [Agentic AIO](https://www.facebook.com/groups/agenticaio/)
|
|
252
|
+
- 🌐 ***More Tools and Documentation***: Visit [Agentic AIO](#) website.
|
|
253
|
+
|
|
254
|
+
---
|
|
255
|
+
|
|
256
|
+
## 📄 License
|
|
257
|
+
|
|
258
|
+
MIT License – see `LICENSE` for details.
|
|
259
|
+
|
|
260
|
+
---
|
|
261
|
+
|
|
262
|
+
## 🤝 Contributing
|
|
263
|
+
|
|
264
|
+
Contributions are welcome! Please see `docs/contributing.md` for guidelines.
|
|
265
|
+
|
|
266
|
+
---
|
|
267
|
+
|
|
268
|
+
## 📚 Troubleshooting
|
|
269
|
+
|
|
270
|
+
Having issues? Check `docs/troubleshooting.md` for common problems and solutions.
|
|
271
|
+
|
|
272
|
+
---
|
|
273
|
+
|
|
274
|
+
♥ Built for the community.
|
|
275
|
+
♥ Shared with love for creators, builders, and learners.
|
axle_cli-1.2.0/README.md
ADDED
|
@@ -0,0 +1,244 @@
|
|
|
1
|
+
# Axle v1.2.0
|
|
2
|
+
|
|
3
|
+
A modular CLI platform for running Python microtools from a shared tools directory.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 🚀 Quick install
|
|
8
|
+
|
|
9
|
+
### Method 1: Install from GitHub (Recommended)
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
pip install git+https://github.com/skpaul82/axle-cli.git
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
That's it! You can now run:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
axle list
|
|
19
|
+
axle run 1 "your prompt"
|
|
20
|
+
axle scan
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
### Method 2: Manual Installation
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
# Clone the repository
|
|
27
|
+
git clone https://github.com/skpaul82/axle-cli.git
|
|
28
|
+
cd axle-cli
|
|
29
|
+
|
|
30
|
+
# Install dependencies
|
|
31
|
+
pip install --upgrade pip
|
|
32
|
+
pip install -r requirements.txt
|
|
33
|
+
|
|
34
|
+
# Install the package
|
|
35
|
+
pip install -e .
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
> **Note**: PyPI installation (`pip install axle-cli`) is planned for future releases. For v1.2.0, please use the GitHub installation method above.
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## 🎉 What's New in v1.2.0
|
|
43
|
+
|
|
44
|
+
### ✨ Optional Security & Code Review
|
|
45
|
+
- **Security and code review are now DISABLED by default** for faster execution
|
|
46
|
+
- Use `--security` and `--code-review` flags to enable per-run
|
|
47
|
+
- Use `axle security enable` and `axle review enable` to enable persistently
|
|
48
|
+
- Configuration stored in `~/.axle/config.json`
|
|
49
|
+
|
|
50
|
+
### 🔄 Built-in Update Command
|
|
51
|
+
- **`axle update`** - Update Axle CLI to the latest version
|
|
52
|
+
- **`axle update --check`** - Check for updates without installing
|
|
53
|
+
- Automatic dependency updates and package reinstallation
|
|
54
|
+
|
|
55
|
+
### 📊 Tool Metadata System
|
|
56
|
+
- **`axle metadata scan`** - Scan all tools and build metadata cache
|
|
57
|
+
- **`axle metadata show <tool>`** - Show detailed tool information
|
|
58
|
+
- **`axle metadata search <query>`** - Search tools by name, functions, or description
|
|
59
|
+
- **`axle metadata list`** - List all tools with summaries
|
|
60
|
+
- View tool functions, parameters, documentation, and imports
|
|
61
|
+
|
|
62
|
+
### 📚 Improved Documentation
|
|
63
|
+
- Updated command reference with all new commands
|
|
64
|
+
- Better inline help and error messages
|
|
65
|
+
- Enhanced user experience
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
## 📦 Features
|
|
70
|
+
|
|
71
|
+
### 🔒 Built-in Security (Optional)
|
|
72
|
+
|
|
73
|
+
- **Pre-execution validation**: Tools can be scanned for security issues before running (optional)
|
|
74
|
+
- **Dangerous pattern detection**: Blocks eval(), exec(), shell=True, and more
|
|
75
|
+
- **Hardcoded secret detection**: Finds passwords, API keys, tokens in code
|
|
76
|
+
- **Configurable security policies**: strict, warn, permissive modes
|
|
77
|
+
- **On-demand validation**: Enable per-run with `--security` flag or persistently with `axle security enable`
|
|
78
|
+
- **Dependency vulnerability scanning**: Integrated pip-audit for package security
|
|
79
|
+
|
|
80
|
+
### 🔍 Automatic Code Review (Optional)
|
|
81
|
+
|
|
82
|
+
- **Pre-execution code quality checks**: Automatic review before running tools (optional)
|
|
83
|
+
- **Auto-fixing**: Fixes formatting (Black) and import sorting (isort) issues
|
|
84
|
+
- **Clear feedback**: Shows exactly what's wrong and how to fix it
|
|
85
|
+
- **Non-blocking**: Won't stop your workflow by default
|
|
86
|
+
- **Manual review**: Run `axle review` anytime for comprehensive checks
|
|
87
|
+
- **CI/CD integration**: Catch issues locally before they reach CI
|
|
88
|
+
- **On-demand review**: Enable per-run with `--code-review` flag or persistently with `axle review enable`
|
|
89
|
+
|
|
90
|
+
### Core Features
|
|
91
|
+
|
|
92
|
+
- Modular platform for running ANY Python tool consistently
|
|
93
|
+
- SEO-focused microtools (keyword checker, meta-tag auditor, etc.)
|
|
94
|
+
- Daily-life automation helpers from the terminal
|
|
95
|
+
- `axle list` shows all tools with numbers
|
|
96
|
+
- `axle run <tool_number_or_name> <prompt>` executes a tool
|
|
97
|
+
- Configurable tools folder path
|
|
98
|
+
|
|
99
|
+
---
|
|
100
|
+
|
|
101
|
+
## 🛠️ Commands
|
|
102
|
+
|
|
103
|
+
| Command | Purpose |
|
|
104
|
+
| -------------------------- | -------------------------------------------- |
|
|
105
|
+
| `axle -V, --version` | Show Axle version. |
|
|
106
|
+
| `axle list` | List all tools in the `tools/` directory. |
|
|
107
|
+
| `axle run 1 "prompt"` | Run tool by number and pass a prompt. |
|
|
108
|
+
| `axle run tool_name ...`| Run by filename (without `.py`). |
|
|
109
|
+
| `axle run 1 "prompt" --security` | Run tool with security validation enabled. |
|
|
110
|
+
| `axle run 1 "prompt" --code-review` | Run tool with code review enabled. |
|
|
111
|
+
| `axle info tool_name` | Show tool description. |
|
|
112
|
+
| `axle scan` | Scan dependencies for known vulnerabilities. |
|
|
113
|
+
| `axle doctor` | Check Python, disk, and required modules. |
|
|
114
|
+
| `axle path` | Show current tools folder location. |
|
|
115
|
+
| `axle review <tool>` | Run code review on a specific tool. |
|
|
116
|
+
| `axle review --all` | Run code review on all tools. |
|
|
117
|
+
| `axle review --fix` | Apply automatic fixes to issues found. |
|
|
118
|
+
| `axle review --enable` | Enable code review by default. |
|
|
119
|
+
| `axle review --disable` | Disable code review by default. |
|
|
120
|
+
| `axle review --show` | Show current code review configuration. |
|
|
121
|
+
| `axle security` | Show or configure security policy. |
|
|
122
|
+
| `axle security --enable` | Enable security validation by default. |
|
|
123
|
+
| `axle security --disable` | Disable security validation by default. |
|
|
124
|
+
| `axle security --show` | Show current security configuration. |
|
|
125
|
+
| `axle update` | Update Axle CLI to the latest version. |
|
|
126
|
+
| `axle update --check` | Check for updates without installing. |
|
|
127
|
+
| `axle metadata scan` | Scan tools and build metadata cache. |
|
|
128
|
+
| `axle metadata show <tool>` | Show detailed metadata for a tool. |
|
|
129
|
+
| `axle metadata search <query>` | Search tools by name, functions, etc. |
|
|
130
|
+
| `axle metadata list` | List all tools with summaries. |
|
|
131
|
+
| `axle help` | Show all commands. |
|
|
132
|
+
|
|
133
|
+
---
|
|
134
|
+
|
|
135
|
+
## 🧱 Requirements
|
|
136
|
+
|
|
137
|
+
- Python 3.10+
|
|
138
|
+
- RAM: 8 GB minimum, 16 GB preferred
|
|
139
|
+
- Disk: 5–8 GB free for models and caches
|
|
140
|
+
- CPU: 2 cores minimum, 4 cores preferred
|
|
141
|
+
|
|
142
|
+
Install via `pip install -r requirements.txt` and `pip install -e .`
|
|
143
|
+
|
|
144
|
+
---
|
|
145
|
+
|
|
146
|
+
## 📝 Docs
|
|
147
|
+
|
|
148
|
+
See:
|
|
149
|
+
|
|
150
|
+
- `docs/index.md` – overview
|
|
151
|
+
- `docs/security.md` – **security validation (MANDATORY)**
|
|
152
|
+
- `docs/installation.md` – step-by-step setup
|
|
153
|
+
- `docs/usage.md` – how to use tools
|
|
154
|
+
- `docs/commands.md` – detailed command reference
|
|
155
|
+
|
|
156
|
+
---
|
|
157
|
+
|
|
158
|
+
## 🔧 Adding Your Own Tools
|
|
159
|
+
|
|
160
|
+
Axle is designed as a platform for tools - you can easily add your own Python scripts!
|
|
161
|
+
|
|
162
|
+
### Tools Directory
|
|
163
|
+
|
|
164
|
+
Run `axle path` to see your tools directory location. By default, it's created at:
|
|
165
|
+
|
|
166
|
+
```
|
|
167
|
+
<axle_install_location>/tools/
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
### How to Add Tools
|
|
171
|
+
|
|
172
|
+
1. **Find your tools directory**:
|
|
173
|
+
|
|
174
|
+
```bash
|
|
175
|
+
axle path
|
|
176
|
+
```
|
|
177
|
+
2. **Create a new Python file** in the tools directory:
|
|
178
|
+
|
|
179
|
+
```bash
|
|
180
|
+
# Example: tools/04_my_tool.py
|
|
181
|
+
```
|
|
182
|
+
3. **Implement the required functions**:
|
|
183
|
+
|
|
184
|
+
```python
|
|
185
|
+
def get_description() -> str:
|
|
186
|
+
"""Return one-line description of the tool."""
|
|
187
|
+
return "Brief description of what your tool does"
|
|
188
|
+
|
|
189
|
+
def main(prompt: str) -> None:
|
|
190
|
+
"""Main entry point. Called by CLI router."""
|
|
191
|
+
# Your tool logic here
|
|
192
|
+
print(f"Processing: {prompt}")
|
|
193
|
+
```
|
|
194
|
+
4. **Run your tool**:
|
|
195
|
+
|
|
196
|
+
```bash
|
|
197
|
+
axle list # Your tool appears in the list
|
|
198
|
+
axle run 4 "your prompt" # Run by number
|
|
199
|
+
axle run my_tool "your prompt" # Run by name
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
### Tool Requirements
|
|
203
|
+
|
|
204
|
+
- ✅ Must implement `get_description()` function (returns string)
|
|
205
|
+
- ✅ Must implement `main(prompt: str)` function (no return value)
|
|
206
|
+
- ✅ File must be valid Python 3.10+
|
|
207
|
+
- ✅ Optional: Use numeric prefix for ordering (e.g., `04_my_tool.py`)
|
|
208
|
+
|
|
209
|
+
**Learn more**: [www.axle.sanjoypaul.com](https://www.axle.sanjoypaul.com)
|
|
210
|
+
|
|
211
|
+
---
|
|
212
|
+
|
|
213
|
+
## 🌐 Community & Support
|
|
214
|
+
|
|
215
|
+
If this helps your workflow:
|
|
216
|
+
|
|
217
|
+
- ⭐ **Star on GitHub**: [skpaul82/axle-cli](https://github.com/skpaul82/axle-cli)
|
|
218
|
+
- 🐦 **Follow on X**: [@_skpaul82](https://x.com/_skpaul82)
|
|
219
|
+
- 🌐 **Website**: [www.axle.sanjoypaul.com](https://www.axle.sanjoypaul.com)
|
|
220
|
+
- 🌐 ***FB Group***: [Agentic AIO](https://www.facebook.com/groups/agenticaio/)
|
|
221
|
+
- 🌐 ***More Tools and Documentation***: Visit [Agentic AIO](#) website.
|
|
222
|
+
|
|
223
|
+
---
|
|
224
|
+
|
|
225
|
+
## 📄 License
|
|
226
|
+
|
|
227
|
+
MIT License – see `LICENSE` for details.
|
|
228
|
+
|
|
229
|
+
---
|
|
230
|
+
|
|
231
|
+
## 🤝 Contributing
|
|
232
|
+
|
|
233
|
+
Contributions are welcome! Please see `docs/contributing.md` for guidelines.
|
|
234
|
+
|
|
235
|
+
---
|
|
236
|
+
|
|
237
|
+
## 📚 Troubleshooting
|
|
238
|
+
|
|
239
|
+
Having issues? Check `docs/troubleshooting.md` for common problems and solutions.
|
|
240
|
+
|
|
241
|
+
---
|
|
242
|
+
|
|
243
|
+
♥ Built for the community.
|
|
244
|
+
♥ Shared with love for creators, builders, and learners.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"""Axle scripts package."""
|