| name | arckit-search |
| description | Search across all project artifacts by keyword, document type, or requirement ID |
Project Search
You are helping an enterprise architect search across all project artifacts to find specific decisions, requirements, risks, or design information.
User Input
$ARGUMENTS
Note: The ArcKit Search hook has already indexed all project artifacts and provided them as structured JSON in the context. Use that data — do NOT scan directories manually.
Instructions
-
Parse the search query from the user input:
- Plain text → keyword search across titles, content previews, and control fields
--type=XXX → filter by document type code (ADR, REQ, HLDR, SECD, etc.)--project=NNN → filter by project number (e.g., --project=001)--id=XX-NNN → find documents containing a specific requirement ID (e.g., --id=BR-003)- Combinations work:
PostgreSQL --type=ADR --project=001
-
Search the pre-processed index from the hook context. Score results by relevance:
- 10 points — match in document title
- 5 points — match in document control fields (owner, status)
- 3 points — match in content preview
- 2 points — match in filename
- Exact matches score double
-
Output format (console only — do NOT create a file):
## Search Results for "<query>"
Found N matches across M projects:
| Score | Document | Type | Project | Title |
|-------|----------|------|---------|-------|
| 15 | ARC-001-ADR-003-v1.0 | ADR | 001-payments | Database Selection |
| 8 | ARC-001-REQ-v2.0 | REQ | 001-payments | System Requirements |
### Top Result Preview
**ARC-001-ADR-003-v1.0** (decisions/ARC-001-ADR-003-v1.0.md)
> ...relevant excerpt from the content preview...
-
Show the top 3 result previews with the matching text highlighted or quoted.
-
If no results found, suggest:
- Broadening the search (fewer keywords, remove filters)
- Checking available document types with their codes
- Trying alternative terms
-
If the query is empty, show a usage summary:
Usage: $arckit-search <query> [--type=TYPE] [--project=NNN] [--id=REQ-ID]
Examples:
$arckit-search PostgreSQL
$arckit-search "data residency" --type=ADR
$arckit-search --id=BR-003
$arckit-search security --project=001
Suggested Next Steps
After completing this command, consider running:
$arckit-health -- Check artifact health after finding relevant documents (when Search revealed potentially stale artifacts)$arckit-traceability -- Trace requirements found in search results (when Search included requirement IDs)$arckit-impact -- Analyse impact of changes to found documents (when User wants to understand change blast radius)
