Summary
Update `docs/CLI_USER_DOC.md` to be the definitive CLI reference, covering every command, subcommand, flag, and exit code.
Depends On: All CLI commands implemented
Parent Issue: #15 (Documentation Completion)
Related: #89 (Fix documentation to include all commands)
Key Changes
- Document every command with:
- Synopsis (command + flags)
- Description
- Options/flags table
- Example usage
- Expected output
- Commands to document:
- `scan` (--deep, --threads)
- `hash` (file path)
- `update-db` (--force)
- `schedule-updates` (--hours)
- `quarantine-file` (path)
- `list-quarantined`
- `restore` (id, --force)
- `remove` (id, --force)
- `remove-file` (path, --force)
- `scan-url` (url)
- Exit codes section: 0, 1, 2 with descriptions
- Troubleshooting section: common issues and fixes
- Environment variables if any are supported
Acceptance Criteria
Summary
Update `docs/CLI_USER_DOC.md` to be the definitive CLI reference, covering every command, subcommand, flag, and exit code.
Depends On: All CLI commands implemented
Parent Issue: #15 (Documentation Completion)
Related: #89 (Fix documentation to include all commands)
Key Changes
Acceptance Criteria