nimling/Nimo
Complete OpenAPI toolkit - generate, convert, merge, and sync API documentation
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Jun 15, 2026
- License
- None
Pinned Snippet
uses: nimling/nimo-api@9f5eee6e6bf158f6b37ba197721197672fd46ea1 # v1.0.20tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| nimo-version | Pinned nimo CLI version | no | 1.0.20 |
| command | Command to run: generate, convert, merge, or sync | yes | convert |
| main | Path to main.go file (for generate command) | no | — |
| readme | Path to README.md file (for generate command) | no | — |
| ai-endpoint | AI API endpoint (for generate command) | no | http://localhost:11434 |
| max-concurrent | Maximum concurrent AI API calls (for generate command) | no | 5 |
| openapi-file | Path to OpenAPI YAML file (for convert command) | no | — |
| output-dir | Output directory for spec.json (for convert command, can also use NIMO_OUTPUT env var) | no | — |
| docs | Output directory for VitePress markdown files (for convert command) | no | — |
| generate-docs | Generate VitePress markdown files in output directory (for convert command) | no | false |
| nginx-output-dir | Output directory for nginx configuration files (for convert command) | no | — |
| common-prefix | Output path prefix for VitePress links (for convert command) | no | — |
| file-prefix | Output filename prefix (for convert command) | no | — |
| index-path | Output index.md path for VitePress features (for convert command) | no | — |
| merge-responses | Merge inline allOf definitions (for convert command) | no | false |
| write-introduction | Write API docs introduction file (for convert command) | no | false |
| inline-examples | Inline #/components/examples/* refs and drop the components.examples map (for convert command) | no | false |
| inline-responses | Inline #/components/responses/* refs and drop the components.responses map (for convert command) | no | false |
| inline-schemas | Inline #/components/schemas/* refs and drop the components.schemas map, circular schemas keep their ref (for convert command) | no | false |
| inline-parameters | Inline #/components/parameters/* refs and drop the components.parameters map (for convert command) | no | false |
| inline | Inline examples, responses, schemas and parameters and write one self contained spec.json (for convert command) | no | false |
| no-refs | After inlining, replace every remaining internal $ref with a deep copy of the referenced node (for convert command) | no | false |
| verbose | Print per iteration diagnostic logs during ref resolution and inlining (for convert command) | no | false |
| verbose-write | Print a line for every file the converter writes to disk (for convert command) | no | false |
| spec-dir | Folder name under the output directory that wraps spec.json and the operations and schemas folders (for convert command) | no | — |
| spec-file | File name for the top entry of the spec output, defaults to spec.json (for convert command) | no | — |
| specs | Space-separated list of spec files to merge (for merge command) | no | — |
| title | Override API title (for merge command) | no | — |
| description | Override API description (for merge command) | no | — |
| version | Override API version (for merge command) | no | — |
| contact-name | Override contact name (for merge command) | no | — |
| contact-email | Override contact email (for merge command) | no | — |
| force | Force overwrite existing file (for merge command) | no | false |
| output | Output file path (for generate and merge commands) | no | — |
| format | Output format: yaml or json (for generate and merge commands) | no | — |
| sync-map | JSON mapping file or inline JSON for sync command | no | — |
Outputs
no outputs