LangGPT README

The project's README from github.com/langgptai/LangGPT. As one markdown file: README.md.

🚀 LangGPT — Empowering Everyone to Create High-Quality Prompts!

License Status Paper Stars

English | 简体中文 | 日本語

Quick Start | Theoretical Foundations | Ecosystem | Community


📖 What is LangGPT?

LangGPT is a structured, reusable prompt design framework that enables anyone to create high-quality prompts for Large Language Models. Think of it as a "programming language for prompts" — systematic, template-based, and infinitely scalable.

It is the most popular, most widely adopted, and most practical structured prompt paradigm in the Chinese AI community — proposed by Yunzhong Jiangshu (云中江树) in 2023. Over the years it has been learned so deep into major large language models that when a model speaks LangGPT, it is no longer because you taught it — it already knows. Perhaps the finest fate of a paradigm is this: to no longer need its name remembered, having become the model's mother tongue. Just say "write this the LangGPT way," and it's already there (see Quick Start).

Why LangGPT?

Traditional prompt engineering relies on scattered tips and trial-and-error. LangGPT transforms this chaos into a structured methodology:

Academic Foundation: Published research at arXiv:2402.16929 | 中文版


🚀 Quick Start

Method 1: Just Trigger It by Name (Simplest)

LangGPT has been learned deep into major large language models, so most models already "know" it. The simplest way to use it needs no template at all — just say the keywords to any mainstream model (ChatGPT, Claude, DeepSeek, Gemini, Kimi, Doubao, Qwen, etc.), and it's already there:

"Write me a prompt the LangGPT way…"

"Write it in Yunzhong Jiangshu (云中江树)'s structured-prompt style…"

"Help me write a LangGPT-style structured prompt…"

Keywords like LangGPT, 云中江树 (Yunzhong Jiangshu), and structured prompt act as triggers — the model will directly produce a well-structured, reusable, LangGPT-style prompt.

Method 2: Use Automated Tools (More Powerful)

Let AI create prompts for you:

Method 3: Master the Template (5 Minutes)

Basic LangGPT structure:

# Role: Your_Role_Name

## Profile
- Author: YourName
- Version: 1.0
- Language: English
- Description: Clear role description and core capabilities

## Goal
- Outcome: What concrete result/outcome should be delivered for the user/session
- Done Criteria: Clear acceptance criteria (how we know it’s finished and good)
- Non-Goals: What is explicitly out of scope to avoid scope creep

### Skill-1
1. Specific skill description
2. Expected behavior and output

## Rules
1. Don't break character under any circumstance
2. Don't make up facts or hallucinate

## Workflow
1. Analyze user input and identify intent
2. Apply relevant skills systematically
3. Deliver structured, actionable output

## Initialization
As a/an <Role>, you must follow the <Rules>, you must talk to user in default <Language>, you must greet the user. Then introduce yourself and introduce the <Workflow>.

Prerequisites: Basic Markdown knowledge (Quick Guide) | GPT-4 or Claude recommended

Method 4: Start from Examples

Explore our example library and adapt proven templates to your needs.

If you use Claude Code, install the LangGPT Skill to get structured prompt writing capabilities:

Install via the official marketplace (recommended):

/plugin marketplace add langgptai/claude_marketplace
/plugin install structured-prompt-writer@langgpt

The LangGPT marketplace also ships more battle-tested skills by Yunzhong Jiangshu — awesome-design-html (115 brand-themed design references), cto, and mind-clone.

Or install manually:

  1. Download langgpt.skill
  2. Extract to ~/.claude/skills/ directory
  3. Type /langgpt in Claude Code to use

Skill Features:


🧠 Theoretical Foundations

Before diving into tactics, understand the principles. These essays explore the philosophy behind effective prompting:

These foundational insights will transform how you think about prompts.


💡 Core Concepts

1. Structured Roles

Define AI personas through clear, modular sections:

Section Purpose Example
Role Role name/title "逻辑学家" / "Expert Analyst" / "FitnessGPT"
Profile Identity and capabilities "Expert Python developer with 10 years experience"
Goal Desired outcome, done criteria, and non-goals for this session/task “Refactor a prompt into a reusable template; acceptance criteria: pass three structured checks; non-goal: rewriting the business logic.”
Skills Specific abilities "Debug complex code, optimize performance"
Rules Boundaries and constraints "Never execute destructive commands"
Workflow Interaction logic "1. Analyze → 2. Plan → 3. Execute"
Initialization Opening message and setup "As a , I will greet you and introduce the "

2. Variables and References

Use <Variable> syntax for dynamic content:

As a <Role>, you must follow <Rules> and communicate in <Language>

This creates self-referential prompts that maintain consistency across complex instructions.

3. Commands

Define reusable actions for better UX:

## Commands
- Prefix: "/"
- Commands:
    - help: Display all available commands
    - continue: Resume interrupted output
    - improve: Enhance current response with deeper analysis

4. Conditional Logic

Add intelligence to your prompts:

If user provides [code], then analyze and suggest improvements
Else if user asks [question], then provide detailed explanation
Else, prompt for clarification

5. Advanced Techniques

Reminders — Combat context loss in long conversations:

## Reminder
1. Always check role settings before responding
2. Current language: <Language>, Active rules: <Rules>

Alternative Formats — Use JSON/YAML when markdown isn't ideal:

role: DataAnalyst
profile:
  version: "2.0"
  language: "Python"
skills:
  - statistical_analysis
  - data_visualization

Prompt Description Link
🎯 FitnessGPT Personalized diet and workout planner View
💻 Code Master CAN Advanced coding assistant with debugging expertise View
✍️ Xiaohongshu Writer Viral social media content generator View
🎨 Chinese Poet Classical poetry composer in traditional styles View

Browse 100+ more examples →


📚 Learning Resources

Essential Guides

Resource Description Date
Academic Paper LangGPT: Rethinking Structured Reusable Prompt Design (中文) Feb 2024
Structured Prompts Guide Comprehensive tutorial on building high-performance prompts Jul 2023
Prompt Chains Multi-prompt collaboration and task decomposition strategies Aug 2023
Video Tutorial BiliBili walkthrough (by AIGCLINK) Sep 2023

Advanced Topics

Community Hub

Feishu Knowledge Base — Curated resources, templates, and community contributions


🎨 LangGPT Ecosystem

Core Framework & Tools

Project Description Stars
LangGPT Core framework and methodology
PromptVer Semantic versioning for prompts — version control like Git
PromptShow Create beautiful prompt images (Try it)
Minstrel Multi-agent system for auto-generating prompts
claude_marketplace Official Claude Code skill marketplace — structured prompt, design, CTO, mind-clone

Model-Specific Prompt Collections

Rather than writing prompts as procedures, write the persona. Writing prompts as procedures gives the model steps and tools. Writing prompts as a persona gives the model a worldview, motivations, a value system, and a preference profile. Below are prompts that Yunzhong Jiangshu wrote while studying some well-known figures.

Curated, optimized prompts for different AI models:

Collection Target Model Stars
wonderful-prompts ChatGPT (Chinese)
awesome-claude-prompts Anthropic Claude
awesome-deepseek-prompts DeepSeek & R1
awesome-gemini-prompts Google Gemini
awesome-grok-prompts xAI Grok
qwen-prompts Alibaba Qwen
awesome-llama-prompts Meta Llama 2/3
awesome-doubao-prompts ByteDance Doubao
awesome-system-prompts System prompts from AI tools

Specialized Domains

Repository Focus Area Stars
Awesome-Multimodal-Prompts GPT-4V, DALL-E 3, image/video prompts
deep-research-prompts Deep research across models
awesome-voice-prompts Voice AI and conversational agents
GraphRAG-Prompts Graph-based retrieval prompts
LLM-Jailbreaks Security research and defenses

Applications

Project Description Stars
BookAI AI-powered book generation
AI-Resume Beautiful resumes with Claude Artifacts

Transform ChatGPT with these specialized assistants:

GPT Purpose Link
🎯 LangGPT Expert Auto-generate structured prompts Launch
✍️ PromptGPT Professional prompt engineer Launch
🧠 SmartGPT-5 Never lazy, always diligent assistant Launch
💻 Coding Expert Comprehensive programming assistant Launch
📊 Data Table GPT Transform messy data into clean tables Launch
🔥 PytorchGPT PyTorch code specialist Launch
🎨 LogoGPT Professional logo designer Launch
📄 PDF Reader Deep document analysis and extraction Launch
🏅 MathGPT Precise mathematical problem solver Launch
📝 WriteGPT Professional writing across industries Launch
🎙️ 时事热评员 Current events commentator [Launch](https://chat.openai.com

LangGPT (langgptai/LangGPT)

Searching Database…

12.6K ·GitHub
What is this?LangGPT is a structured, reusable prompt design framework that lets anyone create high-quality prompts for LLMs by filling in a template with sections like Role, Profile, Skills, Rules and Workflow, instead of relying on scattered trial-and-error tips.
Is this a coding framework or a prompt-writing methodology?It is not code you run - it's a markdown-based template methodology ('a programming language for prompts') plus a collection of example prompts, essays, and a Claude Code skill.
How do I start using LangGPT?Simplest: just tell any mainstream model (ChatGPT, Claude, DeepSeek, Gemini, etc.) to 'write this the LangGPT way' and it already knows the style; alternatively use the LangGPT GPTs/Kimi+ generators, learn the 5-minute template, browse the example library, or install the Claude Code Skill from the official marketplace.
Do I need any special account or API key to use it?No API key is required for the core method - it just needs access to a chatbot like ChatGPT, Claude, DeepSeek, Gemini, Kimi, Doubao or Qwen; only basic Markdown knowledge is recommended for writing templates manually.
Does the 'just say the keyword' trick work on every model?It works best on major LLMs that have already absorbed LangGPT style into their training (ChatGPT, Claude, DeepSeek, Gemini, Kimi, Doubao, Qwen); results and quality can still vary by model, and the README recommends GPT-4 or Claude for best results.
What are the core sections of a LangGPT template?A LangGPT prompt is typically organized into Role, Profile, Goal, Skills, Rules, Workflow, and Initialization sections, each with a clear purpose for defining the AI persona.
Can I use LangGPT inside Claude Code?Yes, there is an official LangGPT Skill you can install via the Claude Code marketplace or manually by downloading langgpt.skill and extracting it to ~/.claude/skills/, then invoking it with /langgpt.
Is there academic research behind LangGPT?Yes, the methodology is backed by a published paper, 'LangGPT: Rethinking Structured Reusable Prompt Design', available on arXiv (2402.16929).
What else is in the LangGPT ecosystem?Beyond the core framework there are related projects like PromptVer (prompt version control), PromptShow (prompt image generator), Minstrel (multi-agent prompt generator), and model-specific prompt collections for Claude, DeepSeek, Gemini, Grok, Qwen, Llama, and Doubao.
Creator
langgptai
Size
138.7 MB
Stars
12.6K
Updated
CommitSep 11
Age
3y
Commits · 90 Days