Support global custom instructions from ~/.grok/GROK.md (#101)

* feat: add support for global custom instructions

* Remove comments

* Fix import syntax for fs-extra module (#112)

* Fix import syntax for fs-extra module

* Fix import syntax for fs-extra module

* Fix import syntax for fs-extra module

* Fix missing newline at end of morph-editor.ts

* Add where to set the API key in the json file (#107)

* Fix diff generation showing entire file as changed (fixes #83) (#98)

The diff preview was showing the entire file as changed when only a few
lines were actually modified. This was caused by a broken change detection
algorithm that couldn't properly handle insertions and deletions.

Replaced the naive line-matching algorithm with a proper LCS (Longest
Common Subsequence) based diff algorithm using dynamic programming. This
produces minimal, accurate diffs that match what git diff shows.

Changes:
- Added computeLCS(): Computes longest common subsequence between old/new lines
- Added extractChanges(): Extracts actual change regions from LCS table
- Updated generateDiff(): Uses LCS-based change detection instead of broken algorithm

Impact:
- Diff previews now show only actual changes (e.g., 4 lines instead of 260)
- Drastically reduces context pollution in conversation history
- Matches git diff output accuracy

🤖 Contributed by ZDS-AI (https://zds.group)

* add model migration manager and new grok models (#124)

* minor tweaks

---------

Co-authored-by: jszczypk <janusz@fide.pl>
Co-authored-by: Ben Faerber <benfaerber@protonmail.com>
Co-authored-by: Joseph Cheek <jcheek@users.noreply.github.com>
Co-authored-by: Ismail Pelaseyed <homanp@gmail.com>

Author: 5 people

README.md

@@ -296,15 +296,19 @@ Options:
 
 ### Custom Instructions
 
-You can provide custom instructions to tailor Grok's behavior to your project by creating a `.grok/GROK.md` file in your project directory:
+You can provide custom instructions to tailor Grok's behavior to your project or globally. Grok CLI supports both project-level and global custom instructions.
+
+#### Project-Level Instructions
+
+Create a `.grok/GROK.md` file in your project directory to provide instructions specific to that project:
 
 ```bash
 mkdir .grok
 ```
 
-Create `.grok/GROK.md` with your custom instructions:
+Create `.grok/GROK.md` with your project-specific instructions:
 ```markdown
-# Custom Instructions for Grok CLI
+# Custom Instructions for This Project
 
 Always use TypeScript for any new code files.
 When creating React components, use functional components with hooks.
@@ -313,7 +317,33 @@ Always add JSDoc comments for public functions and interfaces.
 Follow the existing code style and patterns in this project.
 ```
 
-Grok will automatically load and follow these instructions when working in your project directory. The custom instructions are added to Grok's system prompt and take priority over default behavior.
+#### Global Instructions
+
+For instructions that apply across all projects, create `~/.grok/GROK.md` in your home directory:
+
+```bash
+mkdir -p ~/.grok
+```
+
+Create `~/.grok/GROK.md` with your global instructions:
+```markdown
+# Global Custom Instructions for Grok CLI
+
+Always prioritize code readability and maintainability.
+Use descriptive variable names and add comments for complex logic.
+Follow best practices for the programming language being used.
+When suggesting code changes, consider performance implications.
+```
+
+#### Priority Order
+
+Grok will load custom instructions in the following priority order:
+1. **Project-level** (`.grok/GROK.md` in current directory) - takes highest priority
+2. **Global** (`~/.grok/GROK.md` in home directory) - fallback if no project instructions exist
+
+If both files exist, project instructions will be used. If neither exists, Grok operates with its default behavior.
+
+The custom instructions are added to Grok's system prompt and influence its responses across all interactions in the respective context.
 
 ## Morph Fast Apply (Optional)
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vibe-kit/grok-cli",
-  "version": "0.0.33",
+  "version": "0.0.34",
   "description": "An open-source AI agent that brings the power of Grok directly into your terminal.",
   "type": "module",
   "main": "dist/index.js",

src/utils/custom-instructions.ts

@@ -1,18 +1,26 @@
 import * as fs from 'fs';
 import * as path from 'path';
+import * as os from 'os';
 
 export function loadCustomInstructions(workingDirectory: string = process.cwd()): string | null {
   try {
-    const instructionsPath = path.join(workingDirectory, '.grok', 'GROK.md');
+    let instructionsPath = path.join(workingDirectory, '.grok', 'GROK.md');
 
-    if (!fs.existsSync(instructionsPath)) {
-      return null;
+    if (fs.existsSync(instructionsPath)) {
+      const customInstructions = fs.readFileSync(instructionsPath, 'utf-8');
+      return customInstructions.trim();
     }
-
-    const customInstructions = fs.readFileSync(instructionsPath, 'utf-8');
-    return customInstructions.trim();
+    
+    instructionsPath = path.join(os.homedir(), '.grok', 'GROK.md');
+    
+    if (fs.existsSync(instructionsPath)) {
+      const customInstructions = fs.readFileSync(instructionsPath, 'utf-8');
+      return customInstructions.trim();
+    }
+    
+    return null;
   } catch (error) {
     console.warn('Failed to load custom instructions:', error);
     return null;
   }
-}
+}