@office-ai/aioncli-core 0.26.0 → 0.30.1

package/dist/docs/reference/keyboard-shortcuts.md

@@ -0,0 +1,168 @@
+# Gemini CLI keyboard shortcuts
+
+Gemini CLI ships with a set of default keyboard shortcuts for editing input,
+navigating history, and controlling the UI. Use this reference to learn the
+available combinations.
+
+<!-- KEYBINDINGS-AUTOGEN:START -->
+
+#### Basic Controls
+
+| Action                                                          | Keys                |
+| --------------------------------------------------------------- | ------------------- |
+| Confirm the current selection or choice.                        | `Enter`             |
+| Dismiss dialogs or cancel the current focus.                    | `Esc`<br />`Ctrl+[` |
+| Cancel the current request or quit the CLI when input is empty. | `Ctrl+C`            |
+| Exit the CLI when the input buffer is empty.                    | `Ctrl+D`            |
+
+#### Cursor Movement
+
+| Action                                      | Keys                                       |
+| ------------------------------------------- | ------------------------------------------ |
+| Move the cursor to the start of the line.   | `Ctrl+A`<br />`Home`                       |
+| Move the cursor to the end of the line.     | `Ctrl+E`<br />`End`                        |
+| Move the cursor up one line.                | `Up`                                       |
+| Move the cursor down one line.              | `Down`                                     |
+| Move the cursor one character to the left.  | `Left`                                     |
+| Move the cursor one character to the right. | `Right`<br />`Ctrl+F`                      |
+| Move the cursor one word to the left.       | `Ctrl+Left`<br />`Alt+Left`<br />`Alt+B`   |
+| Move the cursor one word to the right.      | `Ctrl+Right`<br />`Alt+Right`<br />`Alt+F` |
+
+#### Editing
+
+| Action                                           | Keys                                                     |
+| ------------------------------------------------ | -------------------------------------------------------- |
+| Delete from the cursor to the end of the line.   | `Ctrl+K`                                                 |
+| Delete from the cursor to the start of the line. | `Ctrl+U`                                                 |
+| Clear all text in the input field.               | `Ctrl+C`                                                 |
+| Delete the previous word.                        | `Ctrl+Backspace`<br />`Alt+Backspace`<br />`Ctrl+W`      |
+| Delete the next word.                            | `Ctrl+Delete`<br />`Alt+Delete`<br />`Alt+D`             |
+| Delete the character to the left.                | `Backspace`<br />`Ctrl+H`                                |
+| Delete the character to the right.               | `Delete`<br />`Ctrl+D`                                   |
+| Undo the most recent text edit.                  | `Cmd/Win+Z`<br />`Alt+Z`                                 |
+| Redo the most recent undone text edit.           | `Ctrl+Shift+Z`<br />`Shift+Cmd/Win+Z`<br />`Alt+Shift+Z` |
+
+#### Scrolling
+
+| Action                   | Keys                          |
+| ------------------------ | ----------------------------- |
+| Scroll content up.       | `Shift+Up`                    |
+| Scroll content down.     | `Shift+Down`                  |
+| Scroll to the top.       | `Ctrl+Home`<br />`Shift+Home` |
+| Scroll to the bottom.    | `Ctrl+End`<br />`Shift+End`   |
+| Scroll up by one page.   | `Page Up`                     |
+| Scroll down by one page. | `Page Down`                   |
+
+#### History & Search
+
+| Action                                       | Keys     |
+| -------------------------------------------- | -------- |
+| Show the previous entry in history.          | `Ctrl+P` |
+| Show the next entry in history.              | `Ctrl+N` |
+| Start reverse search through history.        | `Ctrl+R` |
+| Submit the selected reverse-search match.    | `Enter`  |
+| Accept a suggestion while reverse searching. | `Tab`    |
+
+#### Navigation
+
+| Action                                             | Keys            |
+| -------------------------------------------------- | --------------- |
+| Move selection up in lists.                        | `Up`            |
+| Move selection down in lists.                      | `Down`          |
+| Move up within dialog options.                     | `Up`<br />`K`   |
+| Move down within dialog options.                   | `Down`<br />`J` |
+| Move to the next item or question in a dialog.     | `Tab`           |
+| Move to the previous item or question in a dialog. | `Shift+Tab`     |
+
+#### Suggestions & Completions
+
+| Action                                  | Keys                 |
+| --------------------------------------- | -------------------- |
+| Accept the inline suggestion.           | `Tab`<br />`Enter`   |
+| Move to the previous completion option. | `Up`<br />`Ctrl+P`   |
+| Move to the next completion option.     | `Down`<br />`Ctrl+N` |
+| Expand an inline suggestion.            | `Right`              |
+| Collapse an inline suggestion.          | `Left`               |
+
+#### Text Input
+
+| Action                                                     | Keys                                                                                |
+| ---------------------------------------------------------- | ----------------------------------------------------------------------------------- |
+| Submit the current prompt.                                 | `Enter`                                                                             |
+| Insert a newline without submitting.                       | `Ctrl+Enter`<br />`Cmd/Win+Enter`<br />`Alt+Enter`<br />`Shift+Enter`<br />`Ctrl+J` |
+| Open the current prompt or the plan in an external editor. | `Ctrl+X`                                                                            |
+| Paste from the clipboard.                                  | `Ctrl+V`<br />`Cmd/Win+V`<br />`Alt+V`                                              |
+
+#### App Controls
+
+| Action                                                                                                                                             | Keys               |
+| -------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
+| Toggle detailed error information.                                                                                                                 | `F12`              |
+| Toggle the full TODO list.                                                                                                                         | `Ctrl+T`           |
+| Show IDE context details.                                                                                                                          | `Ctrl+G`           |
+| Toggle Markdown rendering.                                                                                                                         | `Alt+M`            |
+| Toggle copy mode when in alternate buffer mode.                                                                                                    | `Ctrl+S`           |
+| Toggle YOLO (auto-approval) mode for tool calls.                                                                                                   | `Ctrl+Y`           |
+| Cycle through approval modes: default (prompt), auto_edit (auto-approve edits), and plan (read-only). Plan mode is skipped when the agent is busy. | `Shift+Tab`        |
+| Expand and collapse blocks of content when not in alternate buffer mode.                                                                           | `Ctrl+O`           |
+| Expand or collapse a paste placeholder when cursor is over placeholder.                                                                            | `Ctrl+O`           |
+| Move focus from Gemini to the active shell.                                                                                                        | `Tab`              |
+| Move focus from the shell back to Gemini.                                                                                                          | `Shift+Tab`        |
+| Clear the terminal screen and redraw the UI.                                                                                                       | `Ctrl+L`           |
+| Restart the application.                                                                                                                           | `R`<br />`Shift+R` |
+| Suspend the CLI and move it to the background.                                                                                                     | `Ctrl+Z`           |
+| Show warning when trying to move focus away from shell input.                                                                                      | `Tab`              |
+
+#### Background Shell Controls
+
+| Action                                                             | Keys        |
+| ------------------------------------------------------------------ | ----------- |
+| Dismiss background shell list.                                     | `Esc`       |
+| Confirm selection in background shell list.                        | `Enter`     |
+| Toggle current background shell visibility.                        | `Ctrl+B`    |
+| Toggle background shell list.                                      | `Ctrl+L`    |
+| Kill the active background shell.                                  | `Ctrl+K`    |
+| Move focus from background shell to Gemini.                        | `Shift+Tab` |
+| Move focus from background shell list to Gemini.                   | `Tab`       |
+| Show warning when trying to move focus away from background shell. | `Tab`       |
+
+<!-- KEYBINDINGS-AUTOGEN:END -->
+
+## Additional context-specific shortcuts
+
+- `Option+B/F/M` (macOS only): Are interpreted as `Cmd+B/F/M` even if your
+  terminal isn't configured to send Meta with Option.
+- `!` on an empty prompt: Enter or exit shell mode.
+- `?` on an empty prompt: Toggle the shortcuts panel above the input. Press
+  `Esc`, `Backspace`, any printable key, or a registered app hotkey to close it.
+  The panel also auto-hides while the agent is running/streaming or when
+  action-required dialogs are shown. Press `?` again to close the panel and
+  insert a `?` into the prompt.
+- `Tab` + `Tab` (while typing in the prompt): Toggle between minimal and full UI
+  details when no completion/search interaction is active. The selected mode is
+  remembered for future sessions. Full UI remains the default on first run, and
+  single `Tab` keeps its existing completion/focus behavior.
+- `Shift + Tab` (while typing in the prompt): Cycle approval modes: default,
+  auto-edit, and plan (skipped when agent is busy).
+- `\` (at end of a line) + `Enter`: Insert a newline without leaving single-line
+  mode.
+- `Esc` pressed twice quickly: Clear the input prompt if it is not empty,
+  otherwise browse and rewind previous interactions.
+- `Up Arrow` / `Down Arrow`: When the cursor is at the top or bottom of a
+  single-line input, navigate backward or forward through prompt history.
+- `Number keys (1-9, multi-digit)` inside selection dialogs: Jump directly to
+  the numbered radio option and confirm when the full number is entered.
+- `Ctrl + O`: Expand or collapse paste placeholders (`[Pasted Text: X lines]`)
+  inline when the cursor is over the placeholder.
+- `Double-click` on a paste placeholder (alternate buffer mode only): Expand to
+  view full content inline. Double-click again to collapse.
+
+## Limitations
+
+- On [Windows Terminal](https://en.wikipedia.org/wiki/Windows_Terminal):
+  - `shift+enter` is only supported in version 1.25 and higher.
+  - `shift+tab`
+    [is not supported](https://github.com/google-gemini/gemini-cli/issues/20314)
+    on Node 20 and earlier versions of Node 22.
+- On macOS's [Terminal](<https://en.wikipedia.org/wiki/Terminal_(macOS)>):
+  - `shift+enter` is not supported.

package/dist/docs/reference/memport.md

@@ -0,0 +1,246 @@
+# Memory Import Processor
+
+The Memory Import Processor is a feature that allows you to modularize your
+GEMINI.md files by importing content from other files using the `@file.md`
+syntax.
+
+## Overview
+
+This feature enables you to break down large GEMINI.md files into smaller, more
+manageable components that can be reused across different contexts. The import
+processor supports both relative and absolute paths, with built-in safety
+features to prevent circular imports and ensure file access security.
+
+## Syntax
+
+Use the `@` symbol followed by the path to the file you want to import:
+
+```markdown
+# Main GEMINI.md file
+
+This is the main content.
+
+@./components/instructions.md
+
+More content here.
+
+@./shared/configuration.md
+```
+
+## Supported path formats
+
+### Relative paths
+
+- `@./file.md` - Import from the same directory
+- `@../file.md` - Import from parent directory
+- `@./components/file.md` - Import from subdirectory
+
+### Absolute paths
+
+- `@/absolute/path/to/file.md` - Import using absolute path
+
+## Examples
+
+### Basic import
+
+```markdown
+# My GEMINI.md
+
+Welcome to my project!
+
+@./get-started.md
+
+## Features
+
+@./features/overview.md
+```
+
+### Nested imports
+
+The imported files can themselves contain imports, creating a nested structure:
+
+```markdown
+# main.md
+
+@./header.md @./content.md @./footer.md
+```
+
+```markdown
+# header.md
+
+# Project Header
+
+@./shared/title.md
+```
+
+## Safety features
+
+### Circular import detection
+
+The processor automatically detects and prevents circular imports:
+
+```markdown
+# file-a.md
+
+@./file-b.md
+```
+
+```markdown
+# file-b.md
+
+@./file-a.md <!-- This will be detected and prevented -->
+```
+
+### File access security
+
+The `validateImportPath` function ensures that imports are only allowed from
+specified directories, preventing access to sensitive files outside the allowed
+scope.
+
+### Maximum import depth
+
+To prevent infinite recursion, there's a configurable maximum import depth
+(default: 5 levels).
+
+## Error handling
+
+### Missing files
+
+If a referenced file doesn't exist, the import will fail gracefully with an
+error comment in the output.
+
+### File access errors
+
+Permission issues or other file system errors are handled gracefully with
+appropriate error messages.
+
+## Code region detection
+
+The import processor uses the `marked` library to detect code blocks and inline
+code spans, ensuring that `@` imports inside these regions are properly ignored.
+This provides robust handling of nested code blocks and complex Markdown
+structures.
+
+## Import tree structure
+
+The processor returns an import tree that shows the hierarchy of imported files,
+similar to Claude's `/memory` feature. This helps users debug problems with
+their GEMINI.md files by showing which files were read and their import
+relationships.
+
+Example tree structure:
+
+```
+Memory Files
+ L project: GEMINI.md
+            L a.md
+              L b.md
+                L c.md
+              L d.md
+                L e.md
+                  L f.md
+            L included.md
+```
+
+The tree preserves the order that files were imported and shows the complete
+import chain for debugging purposes.
+
+## Comparison to Claude Code's `/memory` (`claude.md`) approach
+
+Claude Code's `/memory` feature (as seen in `claude.md`) produces a flat, linear
+document by concatenating all included files, always marking file boundaries
+with clear comments and path names. It does not explicitly present the import
+hierarchy, but the LLM receives all file contents and paths, which is sufficient
+for reconstructing the hierarchy if needed.
+
+> [!NOTE] The import tree is mainly for clarity during development and has
+> limited relevance to LLM consumption.
+
+## API reference
+
+### `processImports(content, basePath, debugMode?, importState?)`
+
+Processes import statements in GEMINI.md content.
+
+**Parameters:**
+
+- `content` (string): The content to process for imports
+- `basePath` (string): The directory path where the current file is located
+- `debugMode` (boolean, optional): Whether to enable debug logging (default:
+  false)
+- `importState` (ImportState, optional): State tracking for circular import
+  prevention
+
+**Returns:** Promise&lt;ProcessImportsResult&gt; - Object containing processed
+content and import tree
+
+### `ProcessImportsResult`
+
+```typescript
+interface ProcessImportsResult {
+  content: string; // The processed content with imports resolved
+  importTree: MemoryFile; // Tree structure showing the import hierarchy
+}
+```
+
+### `MemoryFile`
+
+```typescript
+interface MemoryFile {
+  path: string; // The file path
+  imports?: MemoryFile[]; // Direct imports, in the order they were imported
+}
+```
+
+### `validateImportPath(importPath, basePath, allowedDirectories)`
+
+Validates import paths to ensure they are safe and within allowed directories.
+
+**Parameters:**
+
+- `importPath` (string): The import path to validate
+- `basePath` (string): The base directory for resolving relative paths
+- `allowedDirectories` (string[]): Array of allowed directory paths
+
+**Returns:** boolean - Whether the import path is valid
+
+### `findProjectRoot(startDir)`
+
+Finds the project root by searching for a `.git` directory upwards from the
+given start directory. Implemented as an **async** function using non-blocking
+file system APIs to avoid blocking the Node.js event loop.
+
+**Parameters:**
+
+- `startDir` (string): The directory to start searching from
+
+**Returns:** Promise&lt;string&gt; - The project root directory (or the start
+directory if no `.git` is found)
+
+## Best Practices
+
+1. **Use descriptive file names** for imported components
+2. **Keep imports shallow** - avoid deeply nested import chains
+3. **Document your structure** - maintain a clear hierarchy of imported files
+4. **Test your imports** - ensure all referenced files exist and are accessible
+5. **Use relative paths** when possible for better portability
+
+## Troubleshooting
+
+### Common issues
+
+1. **Import not working**: Check that the file exists and the path is correct
+2. **Circular import warnings**: Review your import structure for circular
+   references
+3. **Permission errors**: Ensure the files are readable and within allowed
+   directories
+4. **Path resolution issues**: Use absolute paths if relative paths aren't
+   resolving correctly
+
+### Debug mode
+
+Enable debug mode to see detailed logging of the import process:
+
+```typescript
+const result = await processImports(content, basePath, true);
+```