Skip to content

Add quick start to README.md#46

Merged
kevinbackhouse merged 3 commits intoGitHubSecurityLab:mainfrom
kevinbackhouse:readme
Feb 11, 2026
Merged

Add quick start to README.md#46
kevinbackhouse merged 3 commits intoGitHubSecurityLab:mainfrom
kevinbackhouse:readme

Conversation

@kevinbackhouse
Copy link
Copy Markdown
Contributor

No description provided.

Copilot AI review requested due to automatic review settings February 7, 2026 16:34
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds an introductory “Quick start” section to help users run a demo taskflow and kick off an audit from a GitHub Codespace, while retaining the existing Docker-script workflow guidance.

Changes:

  • Introduces a “Quick start” section with Codespaces-oriented steps and example commands.
  • Adds guidance/warnings about audit runtime and expected output location/format.
  • Rewords and relocates the existing “Running with docker script” section under the new quick start content.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings February 7, 2026 16:49
@kevinbackhouse kevinbackhouse marked this pull request as ready for review February 7, 2026 16:51
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Copy link
Copy Markdown
Contributor

@p- p- left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove instructions that don't work for external users.

Comment thread README.md Outdated
Copilot AI review requested due to automatic review settings February 10, 2026 12:07
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (1)

README.md:13

  • The quick start demo command is presented without mentioning required secrets/env vars (e.g., AI_API_TOKEN and GH_TOKEN). Later in the README you state these variables need to be set, so the quick start section is likely to fail for new users who haven’t configured Codespaces secrets yet. Suggest adding a short prerequisite bullet in Quick start linking to the configuration section or explicitly calling out the required variables.
* Go to https://github.com/GitHubSecurityLab/seclab-taskflows and start a codespace.
* Wait a few minutes for the codespace to start. It's ready when you see `(.venv)` before the prompt in the terminal.
* Run the demo:

```bash
python -m seclab_taskflow_agent -t seclab_taskflows.taskflows.audit.ghsa_variant_analysis_demo -g repo=github/cmark-gfm -g ghsa=GHSA-c944-cv5f-hpvr
</details>



---

💡 <a href="/GitHubSecurityLab/seclab-taskflows/new/main/.github/instructions?filename=*.instructions.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add Copilot custom instructions</a> for smarter, more guided reviews. <a href="https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn how to get started</a>.

Comment thread README.md
Comment thread README.md
> ⚠️ Note: the auditing taskflows can take several hours to run, especially on larger projects, and make a _lot_ of AI requests.
> You will almost certainly need a [Copilot Pro](https://github.com/github-copilot/pro) account to run them.

The results of the audit are written to an SQLite database, which is opened automatically in an SQLite viewer at
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd remove that "which is opened automatically in an SQLite viewer". It will only work properly in the absolute happy path of the current codespace setup. Rather maybe mention repo_context.db and talk about consulting the logs and output.

Comment thread README.md
Comment on lines +25 to +26
The results of the audit are written to an SQLite database, which is opened automatically in an SQLite viewer at
the end of the run. The results are in the table named "audit_result". The table has a column named "has_vulnerability",
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The results of the audit are written to an SQLite database, which is opened automatically in an SQLite viewer at
the end of the run. The results are in the table named "audit_result". The table has a column named "has_vulnerability",
The results of the audit are written to an SQLite database, which you can view with [SQLite viewer](https://marketplace.visualstudio.com/items?itemName=qwtel.sqlite-viewer) if you're in a codespace. The results are in the table named "audit_result". The table has a column named "has_vulnerability",

cc: @p-

@kevinbackhouse kevinbackhouse merged commit f7db21e into GitHubSecurityLab:main Feb 11, 2026
12 checks passed
@kevinbackhouse kevinbackhouse deleted the readme branch February 11, 2026 11:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants