Skip to content

Commit d59a85b

Browse files
committed
improve debug page
1 parent 7d8b8ea commit d59a85b

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

docs/concepts/debug.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,31 @@ sidebar_position: 650
66

77
# Debug
88

9-
Defang includes an AI-driven tool to help you debug your cloud applications. The AI agent will use your service logs as well as the files in your project to help you identify and resolve issues.
9+
Defang includes an AI-driven tool in the CLI (command-line interface) to help you debug your cloud applications. The AI agent will use your service logs as well as the files in your project to help you identify and resolve issues.
1010

1111
:::info
1212
We plan to expand the capabilities of the AI agent in the future.
1313
:::
1414

15-
## How it works
15+
## How It Works
1616

17-
When you deploy a project with Defang, the CLI will wait for all services' statuses to switch to healthy. If any service fails to deploy, the AI debugger will kick in. It will analyze the logs and files in your project to identify the issue and provide you with a suggested fix. **The AI debugger will not change your files.**
17+
Here is a typical workflow in the [Defang CLI](/docs/getting-started) that will automatically run the AI debugger tool:
18+
19+
1. When you deploy a project with Defang (i.e. `defang compose up`), the CLI will wait for all services' statuses to switch to healthy.
20+
21+
2. If any service fails to deploy, the AI debugger will kick in and ask for permission.
22+
23+
3. The AI agent will analyze the logs and files in your project to identify the issue(s).
24+
25+
4. Then, it will provide you with the suggested fix(es) in the terminal.
26+
27+
:::tip
28+
The AI debugger will not change your files. Instead, it will show you a suggestion, and it is up to you if you want to use it in your code.
29+
:::
30+
31+
32+
The AI debugger only kicks in when any service in a project fails to deploy. This could be because of a build failure, healthchecks failing, or a variety of other issues.
1833

1934
:::info
20-
The AI debugger only kicks in when any service in a project fails to deploy. This could be because of a build failure, healthchecks failing, or a variety of other issues. At the moment, we do not offer any way to trigger the AI debugger manually.
35+
The AI debugger only kicks in when any service in a project fails to deploy. At the moment, we do not offer any way to trigger the AI debugger manually.
2136
:::

0 commit comments

Comments
 (0)