elvic-cli
v2.0.0
Published
A powerful AI-powered content strategy agent with a beautiful retro terminal interface. ELVIC helps you create, analyze, and optimize content for blogs, social media, and marketing campaigns.
Maintainers
Readme
ELVIC - Content Strategy Agent
A powerful AI-powered content strategy agent with a beautiful retro terminal interface. ELVIC helps you create, analyze, and optimize content for blogs, social media, and marketing campaigns.
🚀 Quick Install
Install ELVIC globally from npm:
npm install -g elvic-cliThen run it from anywhere:
elvic⚙️ First-time Setup
Installation Troubleshooting
If you encounter permission errors (EACCES) during installation, it's usually because a previous installation was done with sudo. Fix it with:
# Remove old installation
sudo rm -rf $(npm root -g)/elvic-cli
# Reinstall with correct permissions
npm install -g elvic-cliAPI Key Setup
After installation, you'll need to set your OpenAI API key. Choose one of these methods:
Option 1: User Config Directory (Recommended)
mkdir -p ~/.elvic
echo "OPENAI_API_KEY=your_api_key_here" > ~/.elvic/.envOption 2: Environment Variable
export OPENAI_API_KEY=your_api_key_hereOption 3: Local .env File
echo "OPENAI_API_KEY=your_api_key_here" > .envGet your API key from: https://platform.openai.com/api-keys
✨ Features
- 🤖 AI-Powered Content Strategy - Powered by OpenAI's GPT-4o
- 📝 Content Analysis - Analyze existing content for improvements
- 💡 Topic Generation - Generate engaging content ideas
- 📋 Outline Creation - Create structured content outlines
- 🔍 SEO Optimization - Check and improve SEO
- ✨ Content Optimization - Optimize for engagement and conversions
- 📅 Content Calendar - Generate content calendars
- #️⃣ Hashtag Generation - Platform-specific hashtags
- 🧪 A/B Testing - Create A/B test frameworks
- 🔗 URL Reading - Analyze content from URLs
- 🌐 Web Search - Research trends and competitors
- 🖼️ Image Generation - Generate images with DALL-E 3 (supports different aspect ratios)
- 📚 Magazine Creation - Complete 6-step workflow for creating professional magazines
- 🎨 Poster Design - Create beautiful posters with custom fonts
- 👁️ Vision Analysis - Analyze images, identify objects, clone images
- 📄 Document Analysis - Analyze PDF, DOCX, MD, and TXT files
- 💾 Conversation Memory - Remembers your conversation context
- 📁 Project Management - Organize content by projects
- 💬 Drag & Drop - Drag files directly into the terminal
📖 Usage
Run ELVIC from anywhere:
elvicOnce ELVIC is running, you can:
- Ask questions naturally - "Generate 5 blog topics about AI"
- Analyze content - "Analyze this content: [paste content]"
- Read URLs - "What is this website about? [URL]"
- Generate images - "Create a professional image for LinkedIn post about content marketing"
- Create magazines - Follow the 6-step magazine creation workflow
- Type
help- Show detailed help information - Type
copy- Copy the last response to clipboard - Type
save <filename>- Save the last response to a file - Type
project use <name>- Switch to a different project - Type
clear- Clear conversation history - Type
exitorquit- Exit the application
📝 Examples
Content Strategy
> Generate 5 blog topics about AI for small businesses
> Create an outline for a blog post about content marketing
> Analyze this content: [paste your content]
> Optimize this blog post for SEO: [paste content]Research & Analysis
> Read and analyze this URL: https://example.com
> What are the latest trends in content marketing?
> Analyze my competitor's content strategy: [URL]Social Media
> Generate hashtags for Instagram post about technology
> Create a weekly content calendar for a tech startup
> Generate 10 LinkedIn post ideas about productivityImage Generation
> Generate a professional image for LinkedIn post about productivity
> (Agent will ask: format, size, aspect ratio, style)
> Create a square image (1:1) for Instagram about coffee culture
> Generate a landscape image (16:9) for a blog header about AIMagazine Creation
> Create a magazine about sustainable living
> (Follows 6-step workflow: Profile → Content Plan → Articles → Images → Layout → Export)Document & Image Analysis
> Analyze this image: /path/to/image.png
> Identify all objects in this image
> Extract text from this document: /path/to/document.pdf
> Clone this image with a different style🎯 Magazine Creation Workflow
ELVIC includes a complete magazine creation system:
- Create Magazine Profile - Define your magazine's theme, audience, and style
- Generate Content Plan - Create a structured content plan
- Generate Articles - Write full articles with AI
- Image Strategy - Plan images for each article
- Layout Plan - Design page-by-page layout
- Export Magazine - Export in DOCX, DOC, PDF formats
All content is saved to: ~/Documents/ELVIC/projects/{project-name}/
📁 Project Structure
├── assets/
│ └── elvic-logo.png # ELVIC logo image
├── bin/
│ └── elvic.js # Global command entry point
├── src/
│ ├── agent.js # Agent configuration
│ ├── cli.js # Interactive CLI interface
│ ├── config.js # Configuration settings
│ ├── tools/ # Content strategy tools
│ └── utils/ # Utility functions
├── index.js # Main entry point
└── package.json # Dependencies and scripts📋 Requirements
- Node.js 18.0.0 or higher
- OpenAI API key with access to GPT-4o and DALL-E 3
- Terminal with ANSI color support (most modern terminals)
- Internet connection for API calls
Getting Your OpenAI API Key
- Go to OpenAI Platform
- Sign in or create an account
- Click "Create new secret key"
- Copy the key (starts with
sk-) - Save it using one of the methods in "First-time Setup" above
🎬 Quick Start Guide
1. Installation
npm install -g elvic-cli2. Setup API Key
mkdir -p ~/.elvic
echo "OPENAI_API_KEY=sk-your-key-here" > ~/.elvic/.env3. Start Using
elvic4. Try These Commands
Generate 5 blog topics about AICreate an outline for a blog postGenerate a professional image for LinkedInhelp- See all available commands
🔧 Development
Local Development Setup
# Clone the repository
git clone https://github.com/elvic-group/elvic-cli.git
cd elvic-cli
# Install dependencies
npm install
# Make it globally available for testing
npm link
# Run in development mode
npm run devTesting Locally
# Test the global command
elvic
# Run tests
npm test
# Format code
npm run format
# Lint code
npm run lint🐛 Troubleshooting
Permission Errors (EACCES)
If you get permission errors during installation:
sudo rm -rf $(npm root -g)/elvic-cli
npm install -g elvic-cliAPI Key Not Found
Make sure your API key is set in one of these locations:
~/.elvic/.env(recommended)- Environment variable:
export OPENAI_API_KEY=your_key - Local
.envfile in current directory
Command Not Found
After installation, if elvic command is not found:
# Check if it's installed
npm list -g elvic-cli
# Verify PATH includes npm global bin
echo $PATH | grep npm
# Reinstall if needed
npm install -g elvic-cli📦 Publishing
For maintainers - publishing new versions:
# Update version
npm version patch # or minor, or major
# Publish to npm
npm publish🤝 Contributing
Contributions are welcome! Please see CONTRIBUTING.md for guidelines.
📜 Changelog
See CHANGELOG.md for a list of changes and version history.
📄 License
This project is licensed under the ISC License - see the LICENSE file for details.
🙏 Acknowledgments
Built with OpenAI Agents SDK and powered by GPT-4o.
