Replaced Context Generator with CTX

butschster · butschster · commit ac9debad79b7 · 2025-04-05T13:36:08.000+04:00
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -3,8 +3,8 @@ import {withMermaid} from "vitepress-plugin-mermaid";
 
 export default withMermaid({
     ignoreDeadLinks: true,
-    title: "Context Generator Docs",
-    description: "Documentation for Context Generator for LLM",
+    title: "CTX Docs",
+    description: "Documentation for CTX",
     themeConfig: {
         // https://vitepress.dev/reference/default-theme-config
         search: {
@@ -77,7 +77,7 @@ export default withMermaid({
                 items: [
                     {text: 'Instructions (Examples)', link: '/advanced/instructions'},
                     {text: 'Development steps', link: '/advanced/development-steps'},
-                    {text: 'Development with Context Generator', link: '/advanced/development-process'},
+                    {text: 'Development with CTX', link: '/advanced/development-process'},
                     {text: 'LLM Integration: Smart Context Requesting', link: '/advanced/smart-context-requesting'},
                 ],
             },
diff --git a/docs/advanced/development-process.md b/docs/advanced/development-process.md
@@ -1,7 +1,7 @@
-# How to Use Context Generator to Explore and Work with Any Codebase
+# How to Use **CTX** to Explore and Work with Any Codebase
 
-Context Generator is a powerful tool that can help you understand and navigate any codebase, making it easier to
-implement features, fix bugs, and contribute to projects. This guide shows you how to leverage Context Generator's
+**CTX** is a powerful tool that can help you understand and navigate any codebase, making it easier to
+implement features, fix bugs, and contribute to projects. This guide shows you how to leverage **CTX**'s
 capabilities throughout your development workflow.
 
 ## Understanding a New Codebase
@@ -325,7 +325,7 @@ Share this with team members or AI assistants to get feedback on your implementa
 
 ### Pattern 3: Documentation Generation
 
-Use Context Generator to create comprehensive documentation:
+Use **CTX** to create comprehensive documentation:
 
 ```yaml
 documents:
@@ -352,6 +352,6 @@ documents:
 6. **Create Implementation Plans**: Use gathered context to formulate clear implementation strategies
 7. **Share Context Efficiently**: Generate focused context documents to share with team members or AI assistants
 
-By effectively using Context Generator to explore unfamiliar codebases, you can significantly reduce the time needed to
+By effectively using **CTX** to explore unfamiliar codebases, you can significantly reduce the time needed to
 understand complex systems, implement features more confidently, and solve bugs more efficiently. The tool transforms
 overwhelming code exploration into a structured, methodical process that builds comprehensive understanding.
diff --git a/docs/advanced/development-steps.md b/docs/advanced/development-steps.md
@@ -553,6 +553,6 @@ ctx --inline='{
 }'
 ```
 
-These examples illustrate how to use Context Generator effectively at each stage of the development workflow. The
+These examples illustrate how to use **CTX** effectively at each stage of the development workflow. The
 combination of inline ctx commands and clear instructions for AI assistants creates a powerful methodology for managing
 complex development tasks with appropriate context.
diff --git a/docs/advanced/instructions.md b/docs/advanced/instructions.md
@@ -1,5 +1,11 @@
 # Instructions
 
+There are several useful instructions for different tasks. Each instruction is tailored to a specific role or task,
+ensuring clarity and efficiency in the process.
+
+CTX supports also prompts definition straight in the `context.yaml` file. Read more about it in the [Prompts](/prompts)
+section.
+
 ## PHP Developer
 
 ```
@@ -297,4 +303,18 @@ repositories).
 
 By following these principles, repositories will become the **single source of truth** for querying entities, 
 improving maintainability and consistency in the application.
-```
+```
+
+## **Shared Prompts Resources:**
+
+CTX supports importing prompts from external sources, allowing you to leverage community-maintained prompt libraries.
+You can add ready-to-use prompts to your project by adding the following to your `context.yaml`:
+
+```yaml
+import:
+  - type: url
+    url: https://gist.githubusercontent.com/butschster/1b7e597691cc1a6476b15dc120ecbddb/raw/9cda0186689e5c819e1f60b486a9d960fcf412c2/prompts.yaml
+```
+
+These shared prompt collections can help standardize approaches to common development tasks across your team and
+projects. **For more details on working with prompts, see the [Prompts documentation](/prompts)**.
diff --git a/docs/advanced/logging.md b/docs/advanced/logging.md
@@ -1,6 +1,6 @@
 # Logging
 
-Context Generator includes a PSR-3 compliant logging system with console output support. The logger integrates with
+**CTX** includes a PSR-3 compliant logging system with console output support. The logger integrates with
 Symfony Console and respects verbosity levels.
 
 ### Verbosity Levels
diff --git a/docs/advanced/smart-context-requesting.md b/docs/advanced/smart-context-requesting.md
@@ -9,7 +9,7 @@ requests without the need for predefined configuration files.
 
 Before diving into advanced usage, you need to understand:
 
-1. **JSON Schema**: The Context Generator uses a specific JSON structure to define what context to gather
+1. **JSON Schema**: **CTX** uses a specific JSON structure to define what context to gather
 
 > Link to the [JSON Schema](https://raw.githubusercontent.com/context-hub/generator/refs/heads/main/json-schema.json)
 
@@ -34,7 +34,7 @@ through executable commands. This creates a feedback loop that significantly enh
 
 ## Real-World Example Workflow
 
-Here's a complete workflow example showing how an LLM and the Context Generator can work together:
+Here's a complete workflow example showing how an LLM and the **CTX** can work together:
 
 1. **User Question**:
 
@@ -127,7 +127,7 @@ When working with sensitive codebases:
 
 ## Conclusion
 
-The combination of Context Generator's inline configuration and LLMs creates a powerful workflow that drastically
+The combination of **CTX**'s inline configuration and LLMs creates a powerful workflow that drastically
 improves the efficiency of code assistance, troubleshooting, and development guidance. By enabling LLMs to request
 precise context, you eliminate the need for lengthy explanations and manual code searching, leading to faster and more
 accurate solutions.
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -211,7 +211,7 @@ documents:
 
 ## Using variables in configuration
 
-Context Generator supports various types of variables throughout your configuration files, including environment
+**CTX** supports various types of variables throughout your configuration files, including environment
 variables, predefined system variables, and custom configuration variables.
 
 Read more about [variables](./variables.md) in the documentation.
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -1,29 +1,29 @@
-# Contributing to Context Generator
+# Contributing to **CTX**
 
-We're excited to welcome you as a contributor to the Context Generator project! This guide will help you get started
+We're excited to welcome you as a contributor to the **CTX** project! This guide will help you get started
 with contributing to our project.
 
 ## How to Contribute
 
-There are many ways to contribute to Context Generator:
+There are many ways to contribute to **CTX**:
 
 1. **Report Issues**: If you find a bug or have a
    suggestion, [create an issue](https://github.com/context-hub/generator/issues) on our GitHub repository.
 2. **Submit Pull Requests**: Have a fix or a new feature? Submit a pull request!
 3. **Improve Documentation**: Help us make our documentation more clear, comprehensive, and accessible.
-4. **Share Your Use Cases**: Let us know how you're using Context Generator in your projects.
+4. **Share Your Use Cases**: Let us know how you're using **CTX** in your projects.
 
 We label issues that are suitable for community contribution with the `help wanted` tag. Additionally, we use labels
 such as `good first issue` for newcomer-friendly tasks, and complexity indicators to help you choose tasks that match
 your experience level.
 
 I'd be happy to write a better instruction for the Getting Started section that highlights the use of the context.yaml
-file for context generation. This will help new contributors understand how they can use Context Generator itself to
+file for context generation. This will help new contributors understand how they can use **CTX** itself to
 explore and work with the codebase.
 
 ## Getting Started with Contributing
 
-Follow this guide to set up your environment and effectively contribute to the Context Generator project. We've designed
+Follow this guide to set up your environment and effectively contribute to the **CTX** project. We've designed
 a workflow that leverages the tool's own capabilities to help you understand and improve the codebase.
 
 ### 1. Set Up Your Environment
@@ -83,7 +83,7 @@ Run this configuration to generate a visual representation of the codebase struc
 This will create a `docs/file-structure.md` file that outlines the project's organization. Just put this file in the
 Claude project context to help it understand the codebase.
 
-### 3. Explore the Codebase Using Context Generator
+### 3. Explore the Codebase Using **CTX**
 
 The project includes a pre-configured `context.yaml` file to help you explore the codebase:
 
@@ -220,7 +220,7 @@ documents:
 - Include relevant context files or excerpts
 - Reference any related issues
 
-By using Context Generator in your contribution workflow, you'll not only improve the project but also gain firsthand
+By using **CTX** in your contribution workflow, you'll not only improve the project but also gain firsthand
 experience with the tool while developing more effective collaboration patterns with AI assistants.
 
 ## Areas Where Help Is Needed
@@ -232,12 +232,12 @@ We're particularly looking for help with:
 - Creating specialized content modifiers for different languages
 - Building integrations with popular IDEs and tools
 
-Your contributions, big or small, help make Context Generator a better tool for everyone. We look forward to
+Your contributions, big or small, help make **CTX** a better tool for everyone. We look forward to
 collaborating with you!
 
 ## Questions?
 
 If you have any questions about contributing, feel free to open an issue labeled "question" or reach out through the
 [discussions](https://github.com/context-hub/generator/discussions) section on GitHub.
 
-Thank you for considering contributing to Context Generator!
+Thank you for considering contributing to **CTX**!
diff --git a/docs/documents.md b/docs/documents.md
@@ -1,6 +1,6 @@
 # Document
 
-A document is the primary output unit produced by the Context Generator. It represents a complete, formatted context
+A document is the primary output unit produced by the **CTX**. It represents a complete, formatted context
 file that's designed to be shared with Large Language Models (LLMs) like ChatGPT or Claude.
 
 Each document produces a single output file (typically Markdown) that contains all the compiled
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -14,7 +14,9 @@ The PHAR file can be used on any system with PHP 8.2 or higher.
 
 ### Requirements
 
-- Linux or MacOS
+- Linux,
+- MacOS
+- or Windows with or without WSL
 
 The easiest way to install Context Generator is by using our installation script. This automatically downloads the
 latest version and sets it up for immediate use.
@@ -39,6 +41,8 @@ If you install to a system directory like `/usr/local/bin`, you probably need `s
 curl -sSL https://raw.githubusercontent.com/context-hub/generator/main/download-latest.sh | sudo sh
 ```
 
+> **Note**: When using `sudo`, to run the script, you may need use `sudo` to run the `ctx` command as well.
+
 Install to a custom path to avoid using `sudo`:
 
 ```bash
diff --git a/docs/getting-started/command-reference.md b/docs/getting-started/command-reference.md
@@ -78,7 +78,7 @@ ctx version
 ctx v
 ```
 
-Displays the current version of Context Generator.
+Displays the current version of **CTX**.
 
 ```bash
 ctx version --check-updates
@@ -88,7 +88,7 @@ ctx version -c
 
 ## Self-Update
 
-Updates the Context Generator to the latest version.
+Updates the **CTX** to the latest version.
 
 ```bash
 ctx self-update
diff --git a/docs/getting-started/ide-integration.md b/docs/getting-started/ide-integration.md
@@ -1,6 +1,6 @@
 # IDE Integration
 
-To get the best experience when working with Context Generator configuration files, you can use the JSON schema for
+To get the best experience when working with **CTX** configuration files, you can use the JSON schema for
 autocompletion and validation in your IDE:
 
 ## Using schema definition in configuration files
diff --git a/docs/index.md b/docs/index.md
@@ -1,15 +1,19 @@
-# Context Generator for AI-Powered Development
+# CTX: Context as Code (CaC) tool with MCP server inside. 
+### The missing link between your codebase and your LLM.
 
-## What is Context Generator?
+![Good morning, LLM](https://github.com/user-attachments/assets/8129f227-dc3f-4671-bc0e-0ecd2f3a1888)
 
-Context Generator is a tool designed to solve a common problem when working with LLMs like ChatGPT, Claude: providing
-sufficient context about your codebase.
+## What is **CTX**?
 
-> There is an article about Context Generator
+**CTX** is a tool made to solve a big problem when chatting with LLMs like ChatGPT or Claude: **giving them enough
+context about your project**.
+
+> There is an article about **CTX**
 > on [Medium](https://medium.com/@butschster/context-not-prompts-2-0-the-evolution-9c4a84214784) that explains the
 > motivation behind the project and the problem it solves.
 
-It automates the process of building context files from various sources:
+Instead of manually copying or explaining your entire codebase each time, ctx automatically builds neat, organized
+context files from:
 
 - Code files,
 - GitHub repositories,
@@ -24,11 +28,11 @@ context about your codebase.
 
 When working with AI-powered development tools context is everything.
 
-- **Code Refactoring Assistance**: Want AI help refactoring a complex class? Context Generator builds a properly
+- **Code Refactoring Assistance**: Want AI help refactoring a complex class? **CTX** builds a properly
   formatted document containing all relevant code files.
 
 - **Multiple Iteration Development**: Working through several iterations with an AI helper requires constantly updating
-  the context. Context Generator automates this process.
+  the context. **CTX** automates this process.
 
 - **Documentation Generation:** Transform your codebase into comprehensive documentation by combining source code with
   custom explanations. Use AI to generate user guides, API references, or developer documentation based on your actual
diff --git a/docs/mcp-server.md b/docs/mcp-server.md
@@ -4,23 +4,23 @@ The Model Control Protocol (MCP) server is a bridge that enables AI assistants l
 understand your project's context. It acts as an intermediary that provides real-time, structured information about your
 codebase to AI models, enabling more accurate and contextually relevant assistance.
 
-Context Generator now supports the MCP protocol, allowing Claude to seamlessly access your project's contexts, and
+**CTX** now supports the MCP protocol, allowing Claude to seamlessly access your project's contexts, and
 documentation without requiring manual context uploads.
 
 ## How integration works
 
-When you connect Claude to Context Generator via MCP:
+When you connect Claude to **CTX** via MCP:
 
 1. Claude can request specific context about your project directly through the MCP protocol
-2. Context Generator processes these requests by accessing your codebase based on your `context.yaml`
+2. **CTX** processes these requests by accessing your codebase based on your `context.yaml`
 3. Relevant code, documentation, and structural information is formatted and returned to Claude
 4. Claude uses this rich context to provide more accurate, project-aware responses
 
 ```mermaid
 sequenceDiagram
     participant User
     participant Claude
-    participant MCP Server as "Context Generator<br/>MCP Server"
+    participant MCP Server as "CTX<br/>MCP Server"
     participant Files as "Project Files"
     participant Config as "context.yaml/<br/>context.json"
     
@@ -68,7 +68,7 @@ Each operation is handled by a dedicated controller, using appropriate HTTP sema
 
 ## Why?
 
-**Developer-Controlled Context**: As a developer and product owner, YOU know your code best. Context Generator puts you
+**Developer-Controlled Context**: As a developer and product owner, YOU know your code best. **CTX** puts you
 in control of exactly what context is relevant, rather than relying on AI to guess.
 
 ### The Problem with Automatic Context Gathering
@@ -81,12 +81,12 @@ Let's imagine IDE tools like Cursor that attempt to gather context automatically
 3. Without your guidance, they can prioritize the wrong files, including less important context while omitting what you
    actually need
 
-Context Generator solves these problems by giving you explicit control over which parts of your codebase are included,
+**CTX** solves these problems by giving you explicit control over which parts of your codebase are included,
 ensuring the AI receives precisely the information needed to assist you effectively.
 
 ## Setting Up
 
-First of all you need to [install](https://claude.ai/download) Claude app and latest version of Context Generator (**>
+First of all you need to [install](https://claude.ai/download) Claude app and latest version of **CTX** (**>
 1.18.0**).
 
 > **Note**: The MCP server is only available in the desktop version of Claude. The web version does not support it.
@@ -96,7 +96,7 @@ First of all you need to [install](https://claude.ai/download) Claude app and la
 
 1. Download Claude App for your operating system
 2. Open **Settings** → **Developer** → **Edit config** → open config file `claude_desktop_config`
-3. Register the Context Generator MCP server using the appropriate configuration
+3. Register the **CTX** MCP server using the appropriate configuration
 
 --- 
 
diff --git a/docs/mcp/filesystem.md b/docs/mcp/filesystem.md
@@ -1,6 +1,6 @@
 # Filesystem Tools
 
-The Context Generator MCP server includes a comprehensive set of filesystem tools that allow Claude to directly interact
+**CTX** MCP server includes a comprehensive set of filesystem tools that allow Claude to directly interact
 with your project files. These tools enable powerful AI-assisted development workflows and make it easy to analyze,
 modify, and create files without leaving your conversation.
 
diff --git a/docs/mcp/prompts.md b/docs/mcp/prompts.md
@@ -72,15 +72,15 @@ Here's how LLM might use prompts during a conversation:
 
 ## Shareable Prompts
 
-Prompts in Context Generator aren't just static templates - they're designed to be shared, imported, and reused across
+Prompts in **CTX** aren't just static templates - they're designed to be shared, imported, and reused across
 projects and teams. This creates an ecosystem where:
 
 - Teams can maintain consistent approaches to common development tasks
 - Best practices can be encoded once and shared widely
 - Specialized domain knowledge can be packaged into reusable templates
 - The community can collaborate on high-quality prompt libraries
 
-Context Generator supports configuration imports from multiple sources to enable modular configuration management:
+**CTX** supports configuration imports from multiple sources to enable modular configuration management:
 
 ### Import Capabilities
 
@@ -110,6 +110,6 @@ import:
       Authorization: "Bearer ${API_TOKEN}"
 
   # GitHub Gist import (using URL)
-  - url: https://gist.githubusercontent.com/butschster/1b7e597691cc1a6476b15dc120ecbddb/raw/8c0f9d0145dcd260b814f866ec130ec630c80ee8/prompts.yaml
+  - url: https://gist.githubusercontent.com/butschster/1b7e597691cc1a6476b15dc120ecbddb/raw/9cda0186689e5c819e1f60b486a9d960fcf412c2/prompts.yaml
     type: url
 ```
diff --git a/docs/modifiers/aliases.md b/docs/modifiers/aliases.md
diff --git a/docs/quick-start.md b/docs/quick-start.md
diff --git a/docs/sources/text-source.md b/docs/sources/text-source.md
diff --git a/docs/sources/url-source.md b/docs/sources/url-source.md
diff --git a/docs/variables.md b/docs/variables.md
