Skip to content

forge-check

by rob

Developer

Validate a CmdForge tool config.yaml against scrutiny rules before publishing

# forge-check

Validate a CmdForge tool config.yaml against scrutiny rules before publishing

## Installation

This is a CmdForge tool. Install it from the registry:

```bash
cmdforge install forge-check
```

## Usage

Validate a tool configuration by piping the config.yaml content:

```bash
# Validate a tool config
cat ~/.cmdforge/my-tool/config.yaml | forge-check

# Improve honesty check accuracy by providing the README
cat ~/.cmdforge/my-tool/config.yaml | forge-check --readme ~/.cmdforge/my-tool/README.md

# Validate before publishing
cat ~/.cmdforge/my-tool/config.yaml | forge-check --readme ~/.cmdforge/my-tool/README.md && cmdforge publish my-tool
```

## Arguments

| Flag | Default | Description |
|------|---------|-------------|
| `--readme` | "" | Path to README.md file (improves honesty check accuracy) |

## How It Works

1. **run_scrutiny** (code step): Executes validation logic against the tool configuration, checking it against scrutiny rules to ensure it meets publishing standards

The tool analyzes the config.yaml structure and content, optionally cross-referencing with the README to verify accuracy and completeness.

## Dependencies

None

No reviews yet.

Issues

No issues reported for this tool.