Skip to content

Commit 21f6d9e

Browse files
committed
Add application logs section to README and improve documentation layout
1 parent 4fd815c commit 21f6d9e

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

README.md

+37
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ Best Practices:
1111

1212
**Forge: AI-Enhanced Terminal Development Environment**
1313

14+
![Code-Forge Demo](https://antinomy.ai/images/forge_demo_2x.gif)
15+
1416
Forge is a comprehensive coding agent that integrates AI capabilities with your development environment, offering sophisticated assistance while maintaining the efficiency of your existing workflow.
1517

1618
- Advanced AI coding assistant with comprehensive understanding, planning, and execution of complex development tasks
@@ -37,6 +39,9 @@ Forge is a comprehensive coding agent that integrates AI capabilities with your
3739
- [WYSIWYG Shell Experience](#wysiwyg-shell-experience)
3840
- [Command Interruption](#command-interruption)
3941
- [Operation Modes](#operation-modes)
42+
- [ACT Mode (Default)](#act-mode-default)
43+
- [PLAN Mode](#plan-mode)
44+
- [Application Logs](#application-logs)
4045
- [Custom Workflows and Multi-Agent Systems](#custom-workflows-and-multi-agent-systems)
4146
- [Creating Custom Workflows](#creating-custom-workflows)
4247
- [Workflow Configuration](#workflow-configuration)
@@ -202,6 +207,38 @@ In PLAN mode, Forge analyzes and plans but doesn't modify your codebase:
202207

203208
You can easily switch between modes during a session using the `/act` and `/plan` commands. PLAN mode is especially useful for reviewing potential changes before they're implemented, while ACT mode streamlines the development process by handling implementation details for you.
204209

210+
### Application Logs
211+
212+
Forge generates detailed JSON-formatted logs that help with troubleshooting and understanding the application's behavior. These logs provide valuable insights into system operations and API interactions.
213+
214+
**Log Location and Access**
215+
216+
Logs are stored in your application support directory with date-based filenames. The typical path looks like:
217+
218+
```bash
219+
/Users/username/Library/Application Support/forge/logs/forge.log.YYYY-MM-DD
220+
```
221+
222+
You can easily locate log files using the built-in command `/info`, which displays system information including the exact path to your log files.
223+
224+
**Viewing and Filtering Logs**
225+
226+
To view logs in real-time with automatic updates, use the `tail` command:
227+
228+
```bash
229+
tail -f /Users/tushar/Library/Application Support/forge/logs/forge.log.2025-03-07
230+
```
231+
232+
**Formatted Log Viewing with jq**
233+
234+
Since Forge logs are in JSON format, you can pipe them through `jq` for better readability:
235+
236+
```bash
237+
tail -f /Users/tushar/Library/Application Support/forge/logs/forge.log.2025-03-07 | jq
238+
```
239+
240+
This displays the logs in a nicely color-coded structure that's much easier to analyze, helping you quickly identify patterns, errors, or specific behavior during development and debugging.
241+
205242
## Custom Workflows and Multi-Agent Systems
206243

207244
For complex tasks, a single agent may not be sufficient. Forge allows you to create custom workflows with multiple specialized agents working together to accomplish sophisticated tasks.

0 commit comments

Comments
 (0)