combicode 1.3.0 → 1.4.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [1.4.0](https://github.com/aaurelions/combicode/compare/combicode-js-v1.3.0...combicode-js-v1.4.0) (2025-08-13)
+
+
+### Features
+
+* Add --llms-txt flag for llms.txt documentation context ([0817554](https://github.com/aaurelions/combicode/commit/081755435594b0ca5208609b2724eb47bd73c2dc))
+
 ## [1.3.0](https://github.com/aaurelions/combicode/compare/combicode-js-v1.2.1...combicode-js-v1.3.0) (2025-06-25)
 
 

package/README.md

@@ -80,18 +80,28 @@ Use the `--exclude` or `-e` flag with comma-separated glob patterns.
 npx combicode -e "**/*_test.py,docs/**"
 ```
 
+### Generating Context for `llms.txt`
+
+The `--llms.txt` or `-l` flag is designed for projects that use an [`llms.txt`](https://llmstxt.org/) file to specify important documentation. When this flag is used, Combicode inserts a specialized system prompt telling the LLM that the provided context is the project's definitive documentation for a specific version. This helps the LLM provide more accurate answers and avoid using deprecated functions.
+
+```bash
+# Combine all markdown files for an llms.txt context
+npx combicode -l -i .md -o llms.txt
+```
+
 ## All CLI Options
 
-| Option           | Alias | Description                                                  | Default         |
-| ---------------- | ----- | ------------------------------------------------------------ | --------------- |
-| `--output`       | `-o`  | The name of the output file.                                 | `combicode.txt` |
-| `--dry-run`      | `-d`  | Preview files without creating the output file.              | `false`         |
-| `--include-ext`  | `-i`  | Comma-separated list of extensions to exclusively include.   | (include all)   |
-| `--exclude`      | `-e`  | Comma-separated list of additional glob patterns to exclude. | (none)          |
-| `--no-gitignore` |       | Do not use patterns from the project's `.gitignore` file.    | `false`         |
-| `--no-header`    |       | Omit the introductory prompt and file tree from the output.  | `false`         |
-| `--version`      | `-v`  | Show the version number.                                     |                 |
-| `--help`         | `-h`  | Show the help message.                                       |                 |
+| Option           | Alias | Description                                                                    | Default         |
+| ---------------- | ----- | ------------------------------------------------------------------------------ | --------------- |
+| `--output`       | `-o`  | The name of the output file.                                                   | `combicode.txt` |
+| `--dry-run`      | `-d`  | Preview files without creating the output file.                                | `false`         |
+| `--include-ext`  | `-i`  | Comma-separated list of extensions to exclusively include.                     | (include all)   |
+| `--exclude`      | `-e`  | Comma-separated list of additional glob patterns to exclude.                   | (none)          |
+| `--llms-txt`     | `-l`  | Use a specialized system prompt for context generated from an `llms.txt` file. | `false`         |
+| `--no-gitignore` |       | Do not use patterns from the project's `.gitignore` file.                      | `false`         |
+| `--no-header`    |       | Omit the introductory prompt and file tree from the output.                    | `false`         |
+| `--version`      | `-v`  | Show the version number.                                                       |                 |
+| `--help`         | `-h`  | Show the help message.                                                         |                 |
 
 ## License
 

package/index.js

@@ -8,7 +8,7 @@ const glob = require("fast-glob");
 
 const { version } = require("./package.json");
 
-const SYSTEM_PROMPT = `You are an expert software architect. The user is providing you with the complete source code for a project, contained in a single file. Your task is to meticulously analyze the provided codebase to gain a comprehensive understanding of its structure, functionality, dependencies, and overall architecture.
+const DEFAULT_SYSTEM_PROMPT = `You are an expert software architect. The user is providing you with the complete source code for a project, contained in a single file. Your task is to meticulously analyze the provided codebase to gain a comprehensive understanding of its structure, functionality, dependencies, and overall architecture.
 
 A file tree is provided below to give you a high-level overview. The subsequent sections contain the full content of each file, clearly marked with "// FILE: <path>".
 
@@ -17,6 +17,13 @@ Your instructions are:
 2.  **Identify Key Components:** Pay close attention to configuration files (like package.json, pyproject.toml), entry points (like index.js, main.py), and core logic.
 `;
 
+const LLMS_TXT_SYSTEM_PROMPT = `You are an expert software architect. The user is providing you with the full documentation for a project, sourced from the project's 'llms.txt' file. This file contains the complete context needed to understand the project's features, APIs, and usage for a specific version. Your task is to act as a definitive source of truth based *only* on this provided documentation.
+
+When answering questions or writing code, adhere strictly to the functions, variables, and methods described in this context. Do not use or suggest any deprecated or older functionalities that are not present here.
+
+A file tree of the documentation source is provided below for a high-level overview. The subsequent sections contain the full content of each file, clearly marked with "// FILE: <path>".
+`;
+
 function loadDefaultIgnorePatterns() {
   const configPath = path.resolve(__dirname, "config", "ignore.json");
   try {
@@ -108,6 +115,12 @@ async function main() {
       describe: "Comma-separated glob patterns to exclude",
       type: "string",
     })
+    .option("l", {
+      alias: "llms-txt",
+      describe: "Use the system prompt for llms.txt context",
+      type: "boolean",
+      default: false,
+    })
     .option("no-gitignore", {
       describe: "Ignore the project's .gitignore file",
       type: "boolean",
@@ -192,7 +205,10 @@ async function main() {
   const outputStream = fs.createWriteStream(argv.output);
 
   if (!argv.noHeader) {
-    outputStream.write(SYSTEM_PROMPT + "\n");
+    const systemPrompt = argv.llmsTxt
+      ? LLMS_TXT_SYSTEM_PROMPT
+      : DEFAULT_SYSTEM_PROMPT;
+    outputStream.write(systemPrompt + "\n");
     outputStream.write("## Project File Tree\n\n");
     outputStream.write("```\n");
     const tree = generateFileTree(relativeFiles, projectRoot);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "combicode",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "A CLI tool to combine a project's codebase into a single file for LLM context.",
   "main": "index.js",
   "bin": {
@@ -24,7 +24,10 @@
     "prompt",
     "developer-tool",
     "codegen",
-    "chatgpt"
+    "chatgpt",
+    "llms.txt",
+    "llms",
+    "llms-full.txt"
   ],
   "author": "A. Aurelions",
   "license": "MIT",