Skip to content
This repository was archived by the owner on Feb 16, 2026. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
build/
.darn
library/
/library/
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,37 @@ Executes the steps defined in a generated plan.

(For more `darnit` subcommands like `parameters` and `mapping`, refer to `darnit --help`)

## Documentation

- **[Library Quick Start](docs/LIBRARY_QUICKSTART.md)** - Get started with the library system in 5 minutes
- **[Library System Guide](docs/LIBRARY_SYSTEM.md)** - Complete documentation on how the library system works
- **[Library Management](docs/LIBRARY_MANAGEMENT.md)** - Advanced library management and troubleshooting
- **[Architecture Overview](docs/ARCHITECTURE.md)** - High-level system architecture and component interactions

### Key Concepts

- **Actions** - Executable operations (CLI commands, file creation)
- **Templates** - Reusable content patterns
- **Mappings** - Rules that map security findings to remediation actions
- **Library** - Organized collection of actions, templates, and mappings

### Common Commands

```bash
# Library management
darn library init # Initialize new library
darn library sync # Update with latest defaults
darn library diagnose # Troubleshoot issues

# Working with actions
darn action list # List available actions
darn action show <name> # Show action details

# Remediation workflow
darnit plan generate # Generate remediation plan
darnit plan execute # Execute remediation plan
```

---
### Deprecated `darn init`

Expand Down
Loading
Loading