WordLift CLI 🚀

WordLift CLI - Your SEO Assistant - A personalized wrapper for Google's Gemini CLI with custom WordLift branding and additional features for content creation and SEO optimization.

🆕 Version 1.5.0 Available! - Updated to Gemini CLI 0.4.1 with enhanced features and improved performance. Update now for the latest capabilities.

🤖 AI SEO Agent | 📚 Documentation | 💬 Get Support | 🧠 Learn More about Agentic SEO

🎨 WordLift CLI in Action

When you run npx wordlift-cli, you'll see the beautiful WordLift ASCII art logo:

██     ██  ██████  ██████  ██████  ██      ██ ███████ ████████
██     ██ ██    ██ ██   ██ ██   ██ ██      ██ ██         ██
██  █  ██ ██    ██ ██████  ██   ██ ██      ██ █████      ██
██ ███ ██ ██    ██ ██   ██ ██   ██ ██      ██ ██         ██
 ███ ███   ██████  ██   ██ ██████  ███████ ██ ██         ██

🚀 WordLift CLI - Your SEO Assistant

The CLI provides helpful tips to get you started:

1. Ask questions, edit files, or run commands.
2. Be specific for the best results.
3. /help for more information.

✨ Features

• Custom WordLift Branding: Beautiful ASCII art logo and personalized messaging
• SEO-Focused: Pre-configured for content creation and SEO optimization tasks
• Agent Memory System: SEOVoc-based knowledge graph integration for storing strategies and guidelines
• Easy Installation: Simple setup scripts for global or local installation
• Gemini Integration: Full compatibility with Google's Gemini CLI features
• Team Ready: Designed for collaborative content creation workflows

🤖 WordLift AI SEO Agent

This CLI is part of the AI SEO Agent ecosystem - the most advanced AI-powered SEO platform.

🚀 Get started with AI SEO Agent →

• Complete SEO Automation: From keyword research to content optimization
• Knowledge Graph Integration: Semantic SEO powered by structured data
• AI Content Creation: Generate SEO-optimized content at scale
• Performance Analytics: Track and improve your SEO results

🚀 Quick Start

# ⚠️ Limited file access - good for trying out the CLI
npx wordlift-cli

# ✅ Recommended for project work - full file access
npm install -g wordlift-cli
wordlift-cli

# Or clone and install locally for development
git clone https://github.com/wordlift/wordlift-cli.git
cd wordlift-cli
./install.sh

✅ Now available on npm! You can use npx wordlift-cli to try it out, but install globally for full project integration.

📁 Working with Project Files

✅ Smart Project Directory Detection: WordLift CLI v1.0.6+ automatically:

• Detects your current working directory when you run the command
• Provides full access to local files (input, output, etc.) from any directory
• Uses your project's .gemini configuration if it exists
• Maintains proper file permissions and security

Example Usage:

cd /your/project/directory
wordlift-cli
> Read the file input/strategy.md and create content based on it

Previously: npm packages had file access restrictions Now: Full project integration regardless of installation method!

🎨 WordLift Branding

The WordLift CLI includes a temporary patch that replaces Gemini CLI's ASCII art with WordLift branding.

Note: This is a temporary solution until PR #2829 adds native custom ASCII art support.

# Automatic setup (includes patch)
npm run setup

# Manual patch control
npm run patch-ascii    # Apply WordLift branding
npm run unpatch-ascii  # Restore original

The patch automatically detects your Gemini CLI installation and safely modifies the ASCII art component.

📖 Usage

Once installed, you can use WordLift CLI just like Gemini CLI, but with WordLift branding:

# If installed locally
./bin/wordlift-cli.js

# If installed globally
wordlift-cli

# Or run directly via npm
npx wordlift-cli

# The CLI will show the WordLift logo and launch:
🚀 WordLift CLI - Your SEO Assistant

Tips for getting started:
1. Ask questions, edit files, or run commands.
2. Be specific for the best results.
3. /help for more information.

Example Commands

# Content creation
> Create a blog post about sustainable technology trends for 2025

# SEO optimization
> Analyze this article for SEO improvements and suggest meta descriptions

# Content strategy
> Help me create a content calendar for tech industry topics

# File editing
> Edit the article in output/tech-trends-2025.md to improve readability

📦 Installation Options

Option 1: NPM (Recommended)

# Run directly (no installation needed)
npx wordlift-cli

# Or install globally
npm install -g wordlift-cli
wordlift-cli

Option 2: Local Installation

git clone https://github.com/wordlift/wordlift-cli.git
cd wordlift-cli
./install.sh
./bin/wordlift-cli.js

Option 3: Global Installation from Source

git clone https://github.com/wordlift/wordlift-cli.git
cd wordlift-cli
./setup-global.sh
wordlift-cli  # Available system-wide after global setup

🛠️ Configuration

WordLift CLI uses the same configuration as Gemini CLI. Set up your API key:

# Set your Gemini API key
export GEMINI_API_KEY="your-api-key-here"

# Or configure through the CLI
wordlift-cli
> /settings

🌐 NPM Package

Published on npm: wordlift-cli

# View package info
npm info wordlift-cli

# Current version
npm view wordlift-cli version

📁 Project Structure

wordlift-cli/
├── bin/
│   ├── wordlift-cli.js          # Main CLI wrapper
│   └── wordlift-cli-standalone.js # Standalone version
├── .gemini/
│   └── settings.json            # Gemini CLI configuration
├── wordlift-ascii-art.txt       # Custom WordLift logo
├── package.json                 # NPM package configuration
├── install.sh                   # Local installation script
├── setup-global.sh              # Global installation script
└── README.md                    # This file

🔄 Staying Updated

For Users (Recommended)

✅ Global Installation Update:

# Update WordLift CLI to latest version
npm update -g wordlift-cli

# Or reinstall to get latest version
npm install -g wordlift-cli@latest

✅ npx Users (Always Latest):

# npx automatically uses the latest published version
npx wordlift-cli@latest

✅ Check Current Version:

# Check your installed version
wordlift-cli --version
# or
npm list -g wordlift-cli

# Check latest available version
npm view wordlift-cli version

For Developers

📦 Local Development:

# Pull latest WordLift CLI changes
git pull origin main

# Update dependencies
npm install

🔄 What's New in v1.5.0:

• Updated to Gemini CLI 0.4.1 with enhanced features and performance improvements
• Better stability and error handling from latest gemini-cli version
• Access to new capabilities and improved compatibility
• Enhanced dependency management for better reliability

💡 Migration Tip: The update is seamless! Your existing configuration and settings are preserved.

🤝 Contributing

We welcome contributions! See CONTRIBUTING.md for guidelines.

Development Setup

# Clone the repository
git clone https://github.com/wordlift/wordlift-cli.git
cd wordlift-cli

# Install dependencies
npm install

# Test locally
./bin/wordlift-cli.js

Making Changes

1. Fork the repository
2. Create a feature branch: git checkout -b feature/amazing-feature
3. Make your changes
4. Test thoroughly
5. Commit your changes: git commit -m 'Add amazing feature'
6. Push to your branch: git push origin feature/amazing-feature
7. Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🆘 Support

• Issues: GitHub Issues
• Documentation: Setup Guide
• Contributing: Contributing Guide
• Agent Memory System: Testing Guide

🧠 Agent Memory System

WordLift CLI includes an advanced memory system for Agent WordLift that stores guidelines, strategies, and examples in a knowledge graph using SEOVoc vocabulary. This enables the agent to:

• Remember strategies across sessions
• Apply learned guidelines consistently
• Reference successful examples for content creation
• Build knowledge over time for better performance

For testing and validation, see the Agent Memory System Test Instructions.

🙏 Acknowledgments

• Built on top of Google's Gemini CLI
• WordLift team for the vision and branding
• Open source community for inspiration and contributions

Made with ❤️ by the WordLift team