Skip to main content

CheerU-ADK: AI Portfolio Auto-Generation Framework for Job Seekers (Gemini CLI)

Project description

CheerU-ADK

AI Portfolio Auto-Generation Framework for Job Seekers (Gemini CLI)

Python 3.10+ License: MIT PyPI


What is CheerU-ADK?

CheerU-ADK (Cheer You - Agentic Development Kit) is an AI-powered portfolio auto-generation framework for developers preparing for employment.

With simple commands in the Gemini CLI environment:

  • Project Planning: Automatically design projects tailored to your target job
  • Code Generation: AI writes code step by step with TDD
  • GitHub Automation: Generate meaningful commit history
  • Portfolio Documentation: Automatically organize in portfolio format

Installation

# Install with uv (recommended)
uv tool install cheeru-adk

# Or install with pip
pip install cheeru-adk

🚀 Quick Start (5 Minutes)

Step 1: Install & Initialize

# Create your portfolio project
mkdir my-portfolio && cd my-portfolio

# Initialize CheerU-ADK
cheeru-adk init

Step 2: Open Gemini CLI

# Start Gemini CLI in your project
gemini

Step 3: Start Planning

In Gemini CLI, type:

/cheeru-plan "로그인 기능이 있는 Todo App"

The AI will:

  1. Analyze your project requirements
  2. Break down into feature-level SPECs
  3. Generate development roadmap

Step 4: Create Feature SPEC

cheeru-adk spec new "이메일 로그인" --worktree

This creates:

  • SPEC document (.cheeru/specs/SPEC-001/spec.md)
  • Worktree for parallel development (after confirmation)

Step 5: Start TDD Development

# In Gemini CLI
/cheeru-code

The AI will guide you through:

  • RED: Write failing tests
  • GREEN: Implement minimal code
  • REFACTOR: Improve code quality

Step 6: Commit & Document

/cheeru-commit
/cheeru-doc

Workflow Commands

Command Description
/cheeru-start Start a new portfolio project
/cheeru-plan Create feature-level SPECs
/cheeru-code Generate code with TDD
/cheeru-commit Commit to GitHub
/cheeru-doc Generate documentation
/cheeru-resume Resume previous session
/cheeru-issue Create GitHub Issues

Agent System (8 Agents)

CheerU-ADK uses 8 specialized AI agents:

Agent Role Function
project-planner CPO Project planning, SPEC generation
code-generator Orchestrator Code generation coordination
code-reviewer Auditor Code quality and review
test-engineer QA + TDD TDD workflow, testing
backend-dev Backend API, DB, server logic
frontend-dev Frontend UI components
devops-engineer DevOps CI/CD, Git, deployment
technical-writer Docs README, API docs

CLI Commands

# Project
cheeru-adk init              # Initialize project
cheeru-adk status            # Show project status

# SPEC Management
cheeru-adk spec new "name"   # Create SPEC
cheeru-adk spec new "name" --worktree  # Create with worktree
cheeru-adk spec list         # List all SPECs

# TDD Workflow
cheeru-adk tdd start         # Start TDD
cheeru-adk tdd status        # Check TDD status

# Worktree (Parallel Development)
cheeru-adk worktree list     # List worktrees
cheeru-adk worktree merge    # Merge completed work

# Task Management
cheeru-adk task list         # List tasks
cheeru-adk task run <name>   # Run a task

Project Structure

After cheeru-adk init:

your-project/
├── .agent/
│   ├── agents/          # AI agent definitions
│   └── workflows/       # Workflow definitions
├── .cheeru/
│   ├── config.json      # Project settings
│   ├── active_context.md # Session state
│   ├── specs/           # SPEC documents
│   └── tasks.yaml       # Task definitions
├── .gemini/
│   ├── commands/        # Slash commands
│   └── hooks/           # Lifecycle hooks
└── AGENTS.md            # Main orchestrator

Development

git clone https://github.com/Dalgoi/cheeru-adk
cd cheeru-adk
uv sync
uv run pytest  # 169 tests

Contributing

We welcome contributions!

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Submit a Pull Request

Questions or Issues? Please report any bugs or feedback through the Issue tracker.

Made with 😊 for job seekers

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

cheeru_adk-0.0.7.tar.gz (70.1 kB view details)

Uploaded Source

Built Distribution

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

cheeru_adk-0.0.7-py3-none-any.whl (95.8 kB view details)

Uploaded Python 3

File details

Details for the file cheeru_adk-0.0.7.tar.gz.

File metadata

  • Download URL: cheeru_adk-0.0.7.tar.gz
  • Upload date:
  • Size: 70.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.15 {"installer":{"name":"uv","version":"0.9.15","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for cheeru_adk-0.0.7.tar.gz
Algorithm Hash digest
SHA256 b819df6db78e8547856aaa155bc92d3857b2aa88eda69b650efdd3f03a40bf64
MD5 3ecdab61599cdf593b968e69247683ca
BLAKE2b-256 ad17da9dc95bdb3b30b7624df044a2815be76b98761fb5d519472697bbe204f4

See more details on using hashes here.

File details

Details for the file cheeru_adk-0.0.7-py3-none-any.whl.

File metadata

  • Download URL: cheeru_adk-0.0.7-py3-none-any.whl
  • Upload date:
  • Size: 95.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.15 {"installer":{"name":"uv","version":"0.9.15","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for cheeru_adk-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 d7b3208afd2da3f09a0264a77a39bf708e157e497e37437da292aa300ff92ce9
MD5 176391e5ac886a385712d9229376cfae
BLAKE2b-256 ca7768414ea5e188d1ea94b60956ff06e3e1850ae9c390b3171332fbfa6a765f

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