vxcontrol/pentagi
1
0
Fork 0
mirror of https://github.com/vxcontrol/pentagi.git synced 2026-07-20 12:37:04 -04:00
Code Issues 45 Packages Projects Releases 9 Wiki Activity

[GH-ISSUE #61] [Enhancement]: Proper guide how to start #33

New Issue
Open
opened 2026-06-06 22:08:08 -04:00 by yindo · 5 comments
yindo commented 2026-06-06 22:08:08 -04:00
Owner
Copy Link
Copy Source

Originally created by @frankvoelker on GitHub (Oct 9, 2025).
Original GitHub issue: https://github.com/vxcontrol/pentagi/issues/61

Originally assigned to: @asdek on GitHub.

Target Component

Core Services (Frontend UI/Backend API)

Enhancement Description

Problem:

  • There is lots of manual how to setup, but no guide on how to use this thing

Solution:

  • Make documentation and example how to use Pentagi

Technical Details

No response

Designs and Mockups

No response

Alternative Solutions

No response

Verification

  • I have checked that this enhancement hasn't been already proposed
  • This enhancement aligns with PentAGI's goal of autonomous penetration testing
  • I have considered the security implications of this enhancement
  • I have provided clear use cases and benefits
Originally created by @frankvoelker on GitHub (Oct 9, 2025). Original GitHub issue: https://github.com/vxcontrol/pentagi/issues/61 Originally assigned to: @asdek on GitHub. ### Target Component Core Services (Frontend UI/Backend API) ### Enhancement Description Problem: - There is lots of manual how to setup, but no guide on how to use this thing Solution: - Make documentation and example how to use Pentagi ### Technical Details _No response_ ### Designs and Mockups _No response_ ### Alternative Solutions _No response_ ### Verification - [x] I have checked that this enhancement hasn't been already proposed - [x] This enhancement aligns with PentAGI's goal of autonomous penetration testing - [x] I have considered the security implications of this enhancement - [x] I have provided clear use cases and benefits
yindo added the enhancement label 2026-06-06 22:08:08 -04:00
yindo commented 2026-06-06 22:08:09 -04:00
Author
Owner
Copy Link
Copy Source

@asdek commented on GitHub (Oct 9, 2025):

hello @frankvoelker

could you please explain what kind of issues did you face while configuration?

right now official guide contains of running installer tool to configure the solution, also you can see straight forward happy pass.

<!-- gh-comment-id:3385052664 --> @asdek commented on GitHub (Oct 9, 2025): hello @frankvoelker could you please explain what kind of issues did you face while configuration? right now official guide contains of running [installer tool to configure the solution](https://github.com/vxcontrol/pentagi?tab=readme-ov-file#using-installer-recommended), also you can see straight forward [happy pass](https://asciinema.org/a/BHI8GnwhzOnH1EfsQCNRfBatu).
yindo commented 2026-06-06 22:08:09 -04:00
Author
Owner
Copy Link
Copy Source

@frankvoelker commented on GitHub (Oct 9, 2025):

hello @frankvoelker

could you please explain what kind of issues did you face while configuration?

right now official guide contains of running installer tool to configure the solution, also you can see straight forward happy pass.

thats exactly what I mean. There is documentation on how to "install" it but no guide on how to "use" it. What do I do after I login on the web UI. What to write? How to define prompts? There are some example prompt templates but how to use them? How to fill template variables? Where to copy it? Where is documented how to really USE this and not how to INSTALL this

<!-- gh-comment-id:3385065677 --> @frankvoelker commented on GitHub (Oct 9, 2025): > hello [@frankvoelker](https://github.com/frankvoelker) > > could you please explain what kind of issues did you face while configuration? > > right now official guide contains of running [installer tool to configure the solution](https://github.com/vxcontrol/pentagi?tab=readme-ov-file#using-installer-recommended), also you can see straight forward [happy pass](https://asciinema.org/a/BHI8GnwhzOnH1EfsQCNRfBatu). thats exactly what I mean. There is documentation on how to "install" it but no guide on how to "use" it. What do I do after I login on the web UI. What to write? How to define prompts? There are some example prompt templates but how to use them? How to fill template variables? Where to copy it? Where is documented how to really USE this and not how to INSTALL this
yindo commented 2026-06-06 22:08:09 -04:00
Author
Owner
Copy Link
Copy Source

@asdek commented on GitHub (Oct 9, 2025):

I've got, thank you! will append it into README

<!-- gh-comment-id:3385081794 --> @asdek commented on GitHub (Oct 9, 2025): I've got, thank you! will append it into README
yindo commented 2026-06-06 22:08:09 -04:00
Author
Owner
Copy Link
Copy Source

@mrigankad commented on GitHub (May 31, 2026):

This appears to be resolved. As @asdek promised, a usage guide was added to the README in af1bf04 ("docs: add first-use guide after login").

The new How to Use PentAGI After Login section covers exactly the "how to USE (not install)" questions raised here:

  1. Create your first flow — Automation vs Assistant mode, the Use Agents toggle, choosing a provider, and how to phrase a goal (target / assessment type / scope / expected result), with a concrete example prompt.
  2. Use templates — the new-flow template picker, where the example lives (examples/prompts/base_web_pentest.md), and the note that plain natural language works (no special template syntax needed).
  3. Monitor execution & review output — flow view, tool/terminal output, and the Report menu (web view / clipboard / Markdown / PDF).
  4. Steer an active flow via the Assistant view.
  5. Manage flow-scoped files (uploads, resources, container snapshots).

@frankvoelker — does that section answer your "what do I do after login / how do I write and use prompts" questions? If so, this issue can probably be closed.

<!-- gh-comment-id:4585694896 --> @mrigankad commented on GitHub (May 31, 2026): This appears to be **resolved**. As @asdek promised, a usage guide was added to the README in `af1bf04` ("docs: add first-use guide after login"). The new **[How to Use PentAGI After Login](https://github.com/vxcontrol/pentagi#how-to-use-pentagi-after-login)** section covers exactly the "how to USE (not install)" questions raised here: 1. **Create your first flow** — Automation vs Assistant mode, the **Use Agents** toggle, choosing a provider, and how to phrase a goal (target / assessment type / scope / expected result), with a concrete example prompt. 2. **Use templates** — the new-flow template picker, where the example lives ([`examples/prompts/base_web_pentest.md`](https://github.com/vxcontrol/pentagi/blob/main/examples/prompts/base_web_pentest.md)), and the note that plain natural language works (no special template syntax needed). 3. **Monitor execution & review output** — flow view, tool/terminal output, and the **Report** menu (web view / clipboard / Markdown / PDF). 4. **Steer an active flow** via the Assistant view. 5. **Manage flow-scoped files** (uploads, resources, container snapshots). @frankvoelker — does that section answer your "what do I do after login / how do I write and use prompts" questions? If so, this issue can probably be closed.
yindo commented 2026-06-06 22:08:09 -04:00
Author
Owner
Copy Link
Copy Source

@asdek commented on GitHub (May 31, 2026):

@mrigankad thanks for the comment, I left this issue open until the article about installing and configuring the product is published, I will add a comment here once it is published

<!-- gh-comment-id:4586812599 --> @asdek commented on GitHub (May 31, 2026): @mrigankad thanks for the comment, I left this issue open until the article about installing and configuring the product is published, I will add a comment here once it is published
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
enhancement
help wanted
pull-request
Mirrored from GitHub Pull Request
 question
No Label enhancement
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: vxcontrol/pentagi#33
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?