Skip to main content

AI-powered terminal assistant for developers

Project description

DevKit 🛠️

AI-powered terminal assistant for developers

DevKit is your smart companion for the command line. It helps you find the right commands without leaving your terminal, manage and reuse helpful snippets, write perfect git commits, and even turn back time when things go wrong. Spend less time searching and more time coding.


✨ Key Features

AI Command Suggestions:
Ask for any command in plain English.
devkit ask "find files larger than 100MB"

Snippet Manager:
Save, search, and run your favorite commands.
devkit snippet save ports "lsof -i -P -n"

Smart Commits:
Generate conventional commit messages from your changes.
devkit commit --ai

Time-Travel Debugging:
Rewind your command history to see what went wrong.
devkit rewind --analyze

Emergency Rollback:
Get AI-powered help when a deployment breaks.
devkit panic


🚀 Quick Start

1. Installation

Get started in seconds. All you need is Python 3.8+.

pip install devkit-cli

2. Configure Your AI (Optional, but Recommended)

To unlock the AI features, you need a free Google AI API key.

  • Get your key from Google AI Studio.

Set it up with DevKit:

devkit config --api-key YOUR_API_KEY_HERE

3. Basic Usage

Here's a quick tour of what you can do:

# Get a command for finding large files
devkit ask "find all files over 500MB in my home directory"

# Save a useful command as a snippet
devkit snippet save large-files "find ~ -type f -size +500M" --tags "disk,files"

# Run your new snippet anytime
devkit snippet run large-files

# Stage your files and let AI write the commit message
git add .
devkit commit --ai

# Something broke? See what you did last and get an AI analysis.
devkit rewind --analyze

📖 Usage Guide

Installation

The recommended way to install DevKit is via pip:

pip install devkit-cli

This will make the devkit command available in your terminal.


AI Commands

ask - Get Command Suggestions

Never google a command again. Describe what you want to do, and DevKit will give you the command.

devkit ask "how to check disk usage by directory"
devkit ask "compress all jpg images in the current folder"

explain - Understand a Command

Unsure what a cryptic command does? Get a clear, part-by-part explanation.

devkit explain "find . -name '*.py' -exec grep -l 'import' {} \;"
devkit explain "git rebase -i HEAD~3"

Snippet Management

snippet save

Save any command for later use. Adding tags helps you find it easily.

devkit snippet save git-undo "git reset --soft HEAD~1" --tags "git,undo"
devkit snippet save k8s-pods "kubectl get pods -n production" --tags "k8s,prod"

snippet list & snippet search

View all your snippets or find specific ones.

# List everything
devkit snippet list

# Filter by tag
devkit snippet list --tag git

# Search by name, command, or tag
devkit snippet search "git"

snippet run

Execute a saved snippet directly.

devkit snippet run git-undo

Git Commit Helper

commit

Create perfectly formatted conventional commit messages.

# Stage your changes
git add .

# Let AI generate the commit message from your staged changes
devkit commit --ai

# Or use the interactive helper
devkit commit

Time-Travel & Rollback

rewind

View your command history and get AI analysis to debug issues.

# See the last 10 commands you ran
devkit rewind

# Get an AI analysis of what might have gone wrong recently
devkit rewind --analyze

# Show only commands that failed
devkit rewind --failures

panic

Made a mistake in production? Panic mode scans for recent dangerous commands (like deploy, delete, push --force) and suggests how to roll them back.

# Something just broke after a command? Run this immediately!
devkit panic

🤝 Contributing

Interested in making DevKit better? We'd love your help! Whether you're fixing a bug, adding a feature, or improving documentation, your contributions are welcome.

Please read our Contributing Guide to get started with the development setup, code style, and submission process.


📝 License

DevKit is licensed under the MIT License.

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

devkit_cli-0.1.0.tar.gz (23.7 kB view details)

Uploaded Source

Built Distribution

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

devkit_cli-0.1.0-py3-none-any.whl (23.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: devkit_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 23.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for devkit_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 9fc7f01799b05e8ac4fcbbcfeac7f610dfd97c4a0316dd3ef5c337425a7bef64
MD5 b0b8598e61414750b17460f0e9a573cb
BLAKE2b-256 9791804c42b258f9db9050e6a91d8be341e3ee12c1312f4a2cc277a23f3e12cb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: devkit_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 23.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for devkit_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 87d01c33e9e6adf8bef2f77a72bfa4ea7c7ff47e6b2db5d986d5c934ab936d2b
MD5 8084bef5fbcc8344541b18758d62d001
BLAKE2b-256 ecdef2cbce8825a322818bf32e65469d818e832c05ac344a88765c4a49c77596

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