Skip to content

Meet Ellie personal command-line companion designed to take the hassle out of system management and automation.

Notifications You must be signed in to change notification settings

tacheraSasi/ellie

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Ellie - The AI-Powered CLI Companion πŸ€–βœ¨

Go Report Card Code Coverage

Meet Ellie - Your all-in-one terminal buddy for system management, Git workflows, and productivity hacks. Built with ❀️ by Tachera Sasi

Getting Started with Ellie 🌟

πŸ› οΈ Configuration Setup

When you first run Ellie, you'll need to configure it with your details. Here's how to do it across all operating systems:

  1. Run the Configuration Setup: Upon first use, Ellie will automatically prompt you to enter the configuration details.
$ ellie
πŸ”§ Setting up Ellie CLI configuration...
-> Enter your username: Tach
-> Enter your OpenAI API key: sk-123...
-> Enter your Email (optional): [email protected]
βœ… Configuration saved successfully at /home/tach/ellie/.ellie.env
πŸ”§ Want to edit it? Open: /home/tach/ellie/.ellie.env
  • Username: Your preferred username.
  • OpenAI API Key: The API key for ChatGPT integration.
  • Email: Optional, used for personalizing interactions.
  1. Manual Configuration Editing:

    • If you'd like to modify the configuration later, simply open the .ellie.env file located in your home directory (or equivalent) and adjust the values.

    Linux/MacOS:

    nano ~/.ellie/.ellie.env

    Windows:

    notepad %HOMEPATH%\.ellie\.ellie.env

Where is Your Configuration File Located?

  • Linux/MacOS:
    /home/username/ellie/.ellie.env

  • Windows:
    C:\Users\YourUsername\ellie\.ellie.env

The configuration file is created automatically, and you can edit it anytime to update details like your OpenAI key or username.


What's New in v0.0.5? πŸŽ‰

  • Git Superpowers πŸš€ - Full Conventional Commits workflow with interactive prompts
  • Smarter UI 🎨 - Colorized output and emoji-driven interface
  • Enhanced Service Control πŸ”§ - Manage Apache/MySQL with single commands
  • Network Wizardry 🌐 - WiFi connection management made simple
  • AI Integration 🧠 - Built-in ChatGPT functionality
# Just look how pretty it is! ✨
$ ellie git commit
πŸ“ Conventional Commit Builder
─────────────────────────────
πŸ”§ Type (feat, fix, docs, style, refactor, perf, test, chore, revert) ➜ feat
🎯 Scope (optional) ➜ auth
πŸ“Œ Description ➜ Add OAuth2 support
πŸ’¬ Body (optional):
β—Ž Press Enter twice to finish:
Implemented Google and GitHub providers
Updated configuration schema

πŸ’₯ Breaking change? (Y/n) ➜ y
πŸ“£ Breaking change details ➜ Changed config format
πŸ”— Issue number (optional) ➜ 42

✨ Commit Preview:
──────────────────
feat(auth): Add OAuth2 support

Implemented Google and GitHub providers
Updated configuration schema

BREAKING CHANGE: Changed config format

Refs #42
──────────────────
βœ… Successfully committed and pushed!

What's New in v0.0.9? πŸŽ‰

  • Todo Management πŸ“ - Lightweight task tracking with completion status
  • Project Switcher πŸš€ - Quick navigation between projects
  • Enhanced Alias System ⚑ - Create custom command shortcuts
  • Cross-Platform Support πŸ–₯️ - Works seamlessly on Windows, macOS, and Linux
  • Persistent Storage πŸ’Ύ - All data saved in Ellie's config directory
# Manage your tasks like a pro! ✨
$ ellie todo add "Implement OAuth2"
βœ… Added todo #1: Implement OAuth2

$ ellie todo list
Your todos:
❌ #1: Implement OAuth2
βœ… #2: Fix login bug

# Switch projects in a flash! ⚑
$ ellie project add api ~/projects/api
βœ… Added project 'api'

$ ellie switch api
βœ… Switched to project 'api'

Installation ⚑

# 1. Clone the repository
git clone https://github.com/tacheraSasi/ellie.git
cd ellie

# 2. Install dependencies
go get github.com/fatih/color

# 3. Build (choose your method)
make build  # or
go build -o ellie

# 4. Run with personality!
./ellie greet

Core Features 🌟

πŸ› οΈ System Management

# Service Control
ellie start apache    # Start Apache
ellie restart mysql   # Restart MySQL
ellie stop all        # Stop all services

# System Insights
ellie sysinfo         # Show hardware/software specs
ellie network-status  # Detailed network analysis

# Command History
ellie history         # View recent commands (cross-platform)

# Daily Setup
ellie start-day       # Start your dev day (opens apps, services, checks Git)
ellie day-start add apps "code"  # Add apps to open
ellie day-start add services "mysql"  # Add services to start
ellie day-start add git_repos "~/projects/api"  # Add Git repos to check
ellie day-start list  # View your daily setup configuration

# Command Aliases
ellie alias add gs="git status"  # Create custom shortcuts
ellie alias list                 # View all aliases
ellie alias delete gs            # Remove an alias

# Todo Management
ellie todo add "Fix login bug" api high  # Add task with category and priority
ellie todo list                          # View categorized tasks
ellie todo complete 1                    # Mark task as done
ellie todo delete 1                      # Remove a task
ellie todo edit 1 priority high          # Update task priority

# Project Management
ellie project add api ~/projects/api "API Service" backend,nodejs  # Add project with description and tags
ellie project list                                                    # View all projects with details
ellie project search nodejs                                           # Search projects by name/tag/description
ellie switch api                                                      # Quick switch to project

πŸ“‚ File Operations

ellie list ~/projects    # Visual directory listing
ellie create-file draft.md  # Create files with safety checks
ellie open-explorer     # Launch GUI file manager

🌐 Network Management

ellie connect-wifi "Coffee Shop" "p4ssw0rd!"  # Secure WiFi connection
ellie network-status                         # Real-time connection stats

πŸ€– AI Integration

# Chat mode (when no command specified)
ellie How do I fix a 500 error in Apache?

πŸš€ Git Workflows

ellie git status       # Enhanced status display
ellie git commit       # Interactive conventional commit
ellie git push         # Smart push with pre-checks
ellie setup-git        # Configure credentials securely

Conventional Commits Made Easy πŸ“

Ellie guides you through professional commit messages:

$ ellie git commit
πŸ“ Conventional Commit Builder
─────────────────────────────
πŸ”§ Choose from: feat|fix|docs|style|refactor|perf|test|chore|revert
🎯 Add scope (optional module/component)
πŸ“Œ Write clear, concise description
πŸ’¬ Detailed body (Markdown supported)
πŸ’₯ Breaking changes detection
πŸ”— Automatic issue reference formatting

Package Management πŸ“¦

ellie install neofetch    # Cross-platform installs
ellie update              # System-wide updates

Service Management πŸ”Œ

Control services like a pro:

# Start/Restart/Stop services
ellie start apache
ellie restart mysql
ellie stop all

# Systemd integration
ellie check-service nginx  # Coming soon!

Why Ellie? πŸ€”

  1. Human-Friendly 😊 - Designed for actual humans
  2. Context-Aware 🧠 - Remembers your workflow
  3. Safe & Secure πŸ”’ - Validation on every operation
  4. Cross-Platform πŸ–₯️ - Works where you work
  5. Extensible πŸ”Œ - Add your own modules

Real-World Magic ✨

# Full development workflow
ellie start all          # Fire up services
ellie git commit         # Create perfect commit
ellie connect-wifi Work_Network $PASSWORD  # Stay connected
ellie sysinfo            # Monitor resources

Contribution Guide 🌱

Found a bug? Got an idea? Let's build together!

  1. Fork the repo
  2. Create your feature branch
  3. Submit a PR with tests
  4. Join our Discord (coming soon!)
# Happy coding! πŸŽ‰
ellie --version
Ellie CLI Version: 0.0.3

Maintained with ❀️ by Tachera Sasi - Because terminal shouldn't mean terminal boredom!

What's New in v0.0.10? πŸŽ‰

  • Command History Viewer πŸ“œ - Cross-platform command history with pretty printing
  • Daily Setup Routine πŸŒ… - One command to start your dev day
  • Enhanced Project Management πŸš€ - Quick project switching and Git status
  • Cross-Platform App Launcher πŸ–₯️ - Open apps on any OS
  • Smart Service Management πŸ”§ - Start services and check Git status
# View your command history! πŸ“œ
$ ellie history
Recent Commands:
  1: git status
  2: cd ~/projects
  3: ellie todo add "Fix bug"

# Start your day with one command! πŸŒ…
$ ellie start-day
Starting your development day...
Opening applications...
Starting services...
Checking Git repositories...
Pending tasks:
❌ #1: Fix login bug
βœ… #2: Update docs
Your development environment is ready! πŸš€

What's New in v0.0.11? πŸŽ‰

  • Enhanced Todo System πŸ“ - Categories, priorities, and editing
  • Smart Project Management πŸš€ - Tags, descriptions, and search
  • Usage Tracking ⏰ - Last used timestamps for projects
  • Better Organization πŸ“ - Categorized todos and tagged projects
  • Improved Search πŸ” - Find projects by name, tag, or description
# Manage todos with categories and priorities! πŸ“
$ ellie todo add "Fix login bug" api high
βœ… Added todo #1: Fix login bug [api] πŸ”΄ High

$ ellie todo list
Your todos:
πŸ“ api:
  ❌ #1: Fix login bug πŸ”΄ High
  βœ… #2: Update docs 🟑 Medium

# Organize projects with tags and descriptions! πŸš€
$ ellie project add api ~/projects/api "API Service" backend,nodejs
βœ… Added project 'api'

$ ellie project search nodejs
Search results:
πŸ“ api
   πŸ“ API Service
   πŸ“‚ /Users/me/projects/api
   🏷️  backend, nodejs

About

Meet Ellie personal command-line companion designed to take the hassle out of system management and automation.

Topics

Resources

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published