You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
feat: Add planning mode and git operations documentation
- Introduced `mermaid-init.js` for dynamic mermaid diagram rendering based on theme.
- Expanded commands documentation with new sections for Planning & Tasks, Git Operations, and Workflows & Agents.
- Created a new `git.md` file detailing Git operations and auto-commit features.
- Added `planning.md` to describe the Planning Mode for task management.
- Implemented `workflow.md` for saving and orchestrating agent workflows.
- Enhanced `tools.md` with real-time tool execution updates and approval requirements.
- Added unit tests for command handling, action buttons, base block widgets, and block UI components.
Null Terminal integrates deeply with Git to make version control seamless within your AI workflow. Every AI edit becomes a trackable git operation with auto-generated commit messages.
4
+
5
+
## Overview
6
+
7
+
The `GitManager` handles all git interactions, ensuring that changes made by the AI are properly staged, committed, and documented.
8
+
9
+
## Features
10
+
11
+
### Auto-Commit
12
+
13
+
When enabled, the AI will automatically commit changes after writing files. It analyzes the diff and generates a conventional commit message.
|`/git checkout <file>`| Discard changes to a file |
55
+
56
+
## Configuration
57
+
58
+
Configure git behavior in `~/.null/config.json`:
59
+
60
+
```json
61
+
{
62
+
"git": {
63
+
"auto_commit": true,
64
+
"commit_format": "conventional",
65
+
"sign_commits": false,
66
+
"show_diff_on_commit": true,
67
+
"allow_revert": true
68
+
}
69
+
}
70
+
```
71
+
72
+
## Workflow Example
73
+
74
+
1.**AI Change**: You ask the AI to "Refactor the login function".
75
+
2.**Auto-Commit**: The AI modifies `login.py`. Null Terminal detects the change, stages it, generates a commit message like `refactor(auth): simplify login logic`, and commits it.
76
+
3.**Review**: You see the commit block. You click "View Diff" to verify the changes.
77
+
4.**Undo (Optional)**: If the change isn't what you wanted, you type `/undo` to revert the commit and restore the file.
Copy file name to clipboardExpand all lines: docs/user/index.md
+18-22Lines changed: 18 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Null Terminal User Guide
2
2
3
-
Null Terminal is a block-based terminal emulator with integrated multi-provider AI chat and autonomous agent capabilities.
3
+
Null Terminal is a block-based terminal emulator with integrated multi-provider AI chat and autonomous agent capabilities. It bridges the gap between traditional CLI tools and modern AI assistance.
4
4
5
5
## Quick Start
6
6
@@ -27,14 +27,15 @@ Every command and AI interaction creates a distinct "block" in the terminal:
27
27
28
28
Toggle between modes with `Ctrl+Space` or `/ai`.
29
29
30
-
### Agent Mode
30
+
### Agent Capabilities
31
31
Enable autonomous task execution where the AI can:
32
-
- Execute shell commands
33
-
- Read and write files
34
-
- Use MCP tools
35
-
- Chain multiple operations together
32
+
- Execute shell commands and file operations
33
+
-**Plan Complex Tasks**: Create roadmaps with `/plan`
34
+
-**Git Integration**: Auto-commit changes with generated messages
35
+
-**Use MCP Tools**: Connect to external services (databases, cloud, etc.)
36
+
-**Orchestrate Workflows**: Run multi-agent tasks
36
37
37
-
Toggle with `/agent` command.
38
+
Toggle agent mode with `/agent`.
38
39
39
40
## Essential Shortcuts
40
41
@@ -48,28 +49,23 @@ Toggle with `/agent` command.
48
49
|`F3`| Change theme |
49
50
|`Escape`| Cancel current operation |
50
51
51
-
## Essential Commands
52
-
53
-
| Command | Description |
54
-
|---------|-------------|
55
-
|`/ai`| Toggle AI mode |
56
-
|`/agent`| Toggle agent mode |
57
-
|`/model`| Select AI model |
58
-
|`/provider`| Configure AI provider |
59
-
|`/config`| Open settings |
60
-
|`/help`| Show help |
61
-
|`/clear`| Clear history |
62
-
|`/export`| Export conversation |
63
-
|`/todo`| Open task dashboard |
64
-
|`/prompts`| Manage system prompts |
52
+
## Feature Highlights
53
+
54
+
-**Planning Mode**: Review and approve AI plans before execution. [Learn more](planning.md)
55
+
-**Git Operations**: Seamless integration with git workflows. [Learn more](git.md)
56
+
-**Workflows & Agents**: Save sessions and run background tasks. [Learn more](workflow.md)
Null Terminal includes a powerful Planning Mode that allows you to create, review, and execute detailed roadmaps for your AI tasks. This ensures you have control over the AI's approach before any code is written.
4
+
5
+
## Overview
6
+
7
+
Planning Mode breaks down complex objectives into a series of actionable steps. You can review the plan, edit specific steps, and execute them sequentially or all at once.
8
+
9
+
## Usage
10
+
11
+
To start planning mode, use the `/plan` command followed by your goal:
12
+
13
+
```bash
14
+
/plan Refactor the authentication module to use JWTs
15
+
```
16
+
17
+
The AI will analyze your request and generate a structured plan.
18
+
19
+
### Plan Interface
20
+
21
+
The plan is displayed as an interactive block in your terminal:
0 commit comments