Skip to content

๐ŸŽ‰ Complete Heidi CLI Production Release - All Features Ready #93

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weโ€™ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
heidi-dang merged 2 commits into from
Mar 10, 2026
Merged

๐ŸŽ‰ Complete Heidi CLI Production Release - All Features Ready #93

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6c8f942
feat: Add one-click installation section to README
Mar 10, 2026
2354cc4
Merge branch 'main' into user-experience-improvements
heidi-dang Mar 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 62 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Heidi CLI: The "Brain" for Your Local AI

[![One-Click Install](https://img.shields.io/badge/Install-One%20Click-blue?style=for-the-badge&logo=linux)](https://github.com/heidi-dang/heidi-cli#-one-click-installation) [![API Keys](https://img.shields.io/badge/API%20Keys-Unified%20Access-green?style=for-the-badge&logo=api)](https://github.com/heidi-dang/heidi-cli/blob/main/docs/api-keys.md) [![Documentation](https://img.shields.io/badge/Docs-Complete%20Guide-purple?style=for-the-badge&logo=readthedocs)](https://github.com/heidi-dang/heidi-cli/blob/main/docs/how-to-use.md)

Listen, we've all been there. You've got a shiny new LLM running on your laptop, but it's basically a goldfish. It forgets what it did five minutes ago, and it keeps making the same dumb mistakes.

Enter **Heidi CLI**.
Expand All @@ -8,7 +10,66 @@ Heidi is a command-center for a **Unified Learning Suite**. It's not just some f

---

### How the Magic Actually Happens (The 5-Phase Loop)
## ๐Ÿš€ **One-Click Installation**

Install Heidi CLI with a single command! The installer will automatically:
- Clone the latest version from GitHub
- Install all dependencies
- Build and install Heidi CLI
- Verify the installation

### **Linux/macOS**
```bash
# Quick install (one command)
curl -fsSL https://raw.githubusercontent.com/heidi-dang/heidi-cli/main/install | bash
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot Mar 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The "Quick install" command directly pipes a remote script to bash. This practice is generally discouraged due to security risks, as it executes code from an untrusted source without user review. A compromised remote script could lead to arbitrary code execution. While the alternative wget method is provided, the curl | bash approach is presented as the "Quick install" and is inherently less secure. Consider making the download-then-execute method the primary recommendation, or at least add a strong warning about the security implications of piping directly to bash.


# Or download first
wget https://raw.githubusercontent.com/heidi-dang/heidi-cli/main/install
chmod +x install
./install
```

### **Windows (PowerShell)**
```powershell
# Download and run
Invoke-WebRequest -Uri "https://raw.githubusercontent.com/heidi-dang/heidi-cli/main/install.ps1" -OutFile "install.ps1"
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot Mar 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The Set-ExecutionPolicy RemoteSigned command is necessary for running downloaded PowerShell scripts, but it also lowers the security settings for the current user. It would be beneficial to add a note explaining the security implications of this change and perhaps suggest reverting the policy after installation if it's not needed for other tasks, or provide a command to revert it.

Suggested change
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
# WARNING: This command lowers your system's security policy. Consider reverting it after installation if not needed:
# Set-ExecutionPolicy -ExecutionPolicy Default -Scope CurrentUser

.\install.ps1
```

### **After Installation**
```bash
# Verify installation
heidi --version

# Quick start
heidi setup
heidi api generate --name "My First Key"
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot Mar 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The quick start guide includes a command to generate an API key. While useful, it's important to explicitly warn users not to commit generated API keys to version control or share them publicly, as this could lead to security vulnerabilities. The PR description itself shows an API key in the output, reinforcing the need for this warning.

Suggested change
heidi api generate --name "My First Key"
heidi api generate --name "My First Key"
# โš ๏ธ IMPORTANT: Save your API key securely and do NOT commit it to version control!

heidi model serve
```

๐ŸŽ‰ **That's it! Heidi CLI is now installed and ready to use!**

---

## ๐Ÿ“š **Complete Documentation**

**๐Ÿ“– Step-by-Step Guide**: [**docs/how-to-use.md**](docs/how-to-use.md)

From your first model download to enterprise deployment, our comprehensive guide covers:
- โœ… **Quick Start** - Get running in 5 minutes
- โœ… **Setup & Configuration** - Configure your environment
- โœ… **Model Management** - Download and manage models
- โœ… **HuggingFace Integration** - Access 100,000+ models
- โœ… **Token & Cost Tracking** - Monitor usage and costs
- โœ… **Analytics & Monitoring** - Performance insights
- โœ… **Advanced Features** - Power user capabilities
- โœ… **Enterprise Deployment** - Production setup
- โœ… **Troubleshooting** - Common issues and solutions

---

## ๐Ÿš€ **How the Magic Actually Happens (The 5-Phase Loop)**

Think of Heidi like a "Perception-Action-Learning" loop. She's got five internal modules that play together like a well-oiled (and slightly sarcastic) machine:

Expand Down
Loading