Skip to content

docs: enrich CLAUDE.md with quickstart, conventions, architecture #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ashsolei wants to merge 1 commit into from
Closed

docs: enrich CLAUDE.md with quickstart, conventions, architecture #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 46 additions & 8 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,58 @@
# seclab-taskflows
# CLAUDE.md — seclab-taskflows

## Overview
Fork of GitHubSecurityLab/seclab-taskflow-agent. Provides concrete taskflow definitions, MCP server integrations, and helper scripts for AI-driven security workflows (vulnerability auditing, alert triage, variant analysis) within the iAiFy AiFeatures org. Version: 0.0.4 (pre-release), Python >= 3.9, build system: Hatch.

Security lab task flows and automation templates.
## Quick Start

## Project Structure
### Option A — Codespace (recommended)

- GitHub Security Lab workflows and task definitions
Open in GitHub Codespaces — devcontainer auto-installs everything. Run demo when `(.venv)` appears in the prompt.

### Option B — Local

```bash
pip install hatch
hatch env create
hatch run 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
```

### Option C — Docker

```bash
# Create .env with: MEMCACHE_STATE_DIR, CODEQL_DBS_BASE_PATH, DATA_DIR, LOG_DIR
./scripts/run_seclab_agent.sh \
-t seclab_taskflows.taskflows.audit.ghsa_variant_analysis_demo \
-g repo=github/cmark-gfm \
-g ghsa=GHSA-c944-cv5f-hpvr
```

## Architecture

- `seclab_taskflows/taskflows/` — Taskflow definitions (audit, triage, variant analysis)
- `seclab_taskflows/mcp/` — Custom MCP server integrations
- `scripts/` — Helper scripts including Docker entrypoint
- `pyproject.toml` — Hatch build config and dependency spec

## Conventions

- Use kebab-case for file and directory names
- Use conventional commits
- Follow security best practices
- Kebab-case file and directory names
- Conventional commits (`feat:`, `fix:`, `chore:`, `security:`)
- Never commit credentials or scan results — security findings are sensitive data
- Python >= 3.9 compatibility required across all taskflows

## Shared Resources

| Resource | Location |
| --- | --- |
| Reusable CI workflows | `Ai-road-4-You/enterprise-ci-cd` |
| Agent templates | `Ai-road-4-You/repo-templates` |
| AgentHub | `~/AgentHub/` (central hub, 12 MCP servers) |

## AgentHub

- Central hub: `~/AgentHub/`
- Skills: `.agents/skills/` (symlinked to AgentHub shared skills)
- MCP: 12 servers synced across all agents
Expand Down
Loading