YPrompt Documentation

repository·main·Indexed 23 days ago

https://github.com/fish2018/yprompt

An AI prompt engineering platform for discovering requirements and generating, optimizing, and managing professional prompts. Features include version control, a real-time rendering playground, and experimental tools for AI image generation and image-to-prompt reverse engineering.

Tokens
500
Snippets
0
Records
2
Agent score
33%

What's inside YPrompt

  1. Overview of YPrompt features

    main

    YPrompt is an AI-driven tool designed to mine user requirements through dialogue and automatically generate professional prompts. It provides a comprehensive environment for prompt engineering, including optimization, version control, and real-time rendering.

    Core Capabilities:

    • Prompt Generation: AI-guided dialogue to extract requirements and generate professional system prompts.
    • Optimization & Comparison: Optimization of both system and user prompts (with support for building dialogue context) and side-by-side effect comparison.
    • Version Control: Management of prompt versions and the ability to perform historical rollbacks.
    • Playground: A real-time rendering playground that supports multiple output types for immediate visual feedback.
    • Authentication: Supports multiple authentication methods including Linux.do OAuth, Feishu (Lark) OAuth, and local username/password.
    • Database Support: Uses SQLite by default, with an option to use MySQL.
    • Responsive Design: Fully functional on both desktop and mobile devices.

    Experimental Drawing Features:

    • Multi-turn dialogue for image generation and image editing.
    • Drag-and-drop support for uploading images and reordering image attachments.
    • Concurrent generation of 1-4 images.
    • Prompt translation support.
    • Image management: Preview, download, delete, and view detailed parameters/prompts from the results area.
    • Image-to-prompt (reverse engineering), quality analysis, and prompt optimization for images.
  2. License and Usage Restrictions for YPrompt

    main

    YPrompt is licensed under the CC BY-NC-SA 4.0 license. When using or building upon this project, you must adhere to the following terms:

    • Non-Commercial: Any form of commercial use is strictly prohibited.
    • Personal/Educational Use: Personal learning and non-commercial purposes are permitted.
    • ShareAlike: Derivative works must be distributed under the same license.
    • Attribution: Any secondary development must clearly credit the original project address.