code-context-extractor 0.1.0 → 0.1.2

package/README.md

@@ -13,31 +13,32 @@ CodeContextExtractor is a local-only CLI that captures a deterministic snapshot
 
 ## Quick start
 ```bash
-npm install
-npm run build
-npx --no-install code-context-extractor extract . --verbose
+npx code-context-extractor extract . --verbose
 ```
 
-The output is written to `.code-context/` with a timestamped filename like:
+The output is written to `code-context/` with a timestamped filename like:
+```
+code-context/<root>_context_YYYY-MM-DD_HHMMSS.txt
 ```
-.code-context/<root>_context_YYYY-MM-DD_HHMMSS.txt
+
+## Install from npm
+```bash
+npx code-context-extractor extract C:\projects\MyNewProject --verbose
 ```
 
 ## Important: .gitignore your outputs
 > **Warning ⚠️**  
-> CodeContextExtractor writes files into a `.code-context/` folder inside your project root. If that folder is not ignored, you may accidentally commit and push your context exports.
+> CodeContextExtractor writes files into a `code-context/` folder inside your project root. If that folder is not ignored, you may accidentally commit and push your context exports.
 
 Add this line to your project's `.gitignore`:
 ```
-.code-context/
+code-context/
 ```
 
 ## npm and npx (for beginners)
 - `npm` is the package manager that installs tools and libraries.
 - `npx` runs a tool. If it is not installed locally, it will try to download it.
-- `--no-install` tells `npx` to only use what is already installed and skip downloads.
-
-In this repo, `code-context-extractor` is not published to npm yet, so `npx` needs `--no-install` or a direct `node dist/cli.js` call.
+- `npx` is great for one-off CLI runs without a global install.
 
 ## User journey (example)
 You want to generate a context file for a project at `C:\projects\MyNewProject`.
@@ -48,6 +49,7 @@ git clone https://github.com/Rwstrobe/CodeContextExtractor.git
 cd CodeContextExtractor
 npm install
 npm run build
+npm link
 ```
 
 ### Step 2: Go to your project folder
@@ -57,23 +59,23 @@ cd C:\projects\MyNewProject
 
 ### Step 3: Generate the context file
 ```bash
-npx --no-install code-context-extractor extract . --verbose
+code-context-extractor extract . --verbose
 ```
 
 The output will be saved to:
 ```
-.\.code-context\MyNewProject_context_YYYY-MM-DD_HHMMSS.txt
+.\code-context\MyNewProject_context_YYYY-MM-DD_HHMMSS.txt
 ```
 
 ### macOS/Linux variant
 You can follow the same steps with a Unix-style path:
 ```bash
 cd ~/projects/MyNewProject
-npx --no-install code-context-extractor extract . --verbose
+code-context-extractor extract . --verbose
 ```
 The output will be saved to:
 ```
-./.code-context/MyNewProject_context_YYYY-MM-DD_HHMMSS.txt
+./code-context/MyNewProject_context_YYYY-MM-DD_HHMMSS.txt
 ```
 
 ## Install from GitHub (beginner-friendly)
@@ -93,9 +95,13 @@ npm install
 ```bash
 npm run build
 ```
-5. Run the extractor:
+5. Link the CLI so it is available on your PATH:
 ```bash
-npx --no-install code-context-extractor extract . --verbose
+npm link
+```
+6. Run the extractor:
+```bash
+code-context-extractor extract . --verbose
 ```
 
 If you prefer, you can run the built CLI directly:
@@ -112,25 +118,21 @@ node dist/cli.js extract . --verbose
 - Streaming output (does not load large files into memory)
 - Conservative redaction enabled by default
 - Optional Markdown output
-- Automatic output folder `.code-context/`
+- Automatic output folder `code-context/`
 
 ## Commands
 ### Extract
 ```bash
-npx --no-install code-context-extractor extract [path]
+code-context-extractor extract [path]
 ```
 Example:
 ```bash
-npx --no-install code-context-extractor extract ./project --format md --depth 3 --verbose
-```
-If you installed the CLI globally (for example via `npm link` or a future npm publish), you can run:
-```bash
-code-context-extractor extract [path]
+code-context-extractor extract ./project --format md --depth 3 --verbose
 ```
 
 ## Options
 ```bash
---out <file>            Output file (default: .code-context/<root>_context_YYYY-MM-DD_HHMMSS.txt)
+--out <file>            Output file (default: code-context/<root>_context_YYYY-MM-DD_HHMMSS.txt)
 --format <text|md>      Output format (default: text)
 --depth <n>             Tree depth (default: 4)
 --include <glob>        Include glob (repeatable)
@@ -171,7 +173,7 @@ node_modules
 dist
 build
 out
-.code-context
+code-context
 .next
 .turbo
 .git
@@ -194,7 +196,7 @@ id_ed25519
 Use an optional JSON file (example: `example-config.json`) to set defaults.
 ```json
 {
-  "outFile": ".code-context/project_context_2026-01-19_145227.txt",
+  "outFile": "code-context/project_context_2026-01-19_145227.txt",
   "format": "text",
   "depth": 4,
   "include": [],

package/dist/config.js

@@ -13,7 +13,7 @@ exports.DEFAULT_EXCLUDES = [
     'dist/**',
     'build/**',
     'out/**',
-    '.code-context/**',
+    'code-context/**',
     '.next/**',
     '.turbo/**',
     '.git/**',
@@ -87,7 +87,7 @@ function buildAutoOutFile(rootPath, format) {
         pad(now.getDate())
     ].join('-');
     const time = [pad(now.getHours()), pad(now.getMinutes()), pad(now.getSeconds())].join('');
-    return path_1.default.join('.code-context', `${rootName}_context_${stamp}_${time}.${ext}`);
+    return path_1.default.join('code-context', `${rootName}_context_${stamp}_${time}.${ext}`);
 }
 function normalizeFormat(value) {
     return value === 'md' ? 'md' : 'text';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "code-context-extractor",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Local-only CLI tool to extract codebase context into a single text or Markdown file.",
   "license": "MIT",
   "author": "Open Source Contributors",