gidevo-api-tool
v0.2.0
Published
Agentic API integration and SDK generation CLI for OpenAPI and GraphQL projects.
Maintainers
Readme
GIDEVO API Tool
Agentic API integration and SDK generation CLI for OpenAPI and GraphQL projects.
Requirements
- Node.js 24 or newer.
- CI tests run on Node 24 LTS and Node 26 Current.
- v0.2 is ESM-first. Programmatic imports should use ESM
import.
Install
npm install -g gidevo-api-toolQuick Start
gidevo-api-tool doctor --spec ./specs/api.yaml
gidevo-api-tool workflow --spec ./specs/api.yaml --language typescript --output ./generatedThe workflow command validates first, then generates the SDK. Use --dry-run to inspect the plan without writing files.
gidevo-api-tool workflow --spec ./specs/api.yaml --language go --dry-run --jsonCommands
| Command | Alias | Purpose |
| ----------------------------- | ----- | -------------------------------------------------------- |
| init | i | Create an OpenAPI or GraphQL project scaffold. |
| doctor | | Run read-only project health checks. |
| workflow | | Validate a spec and generate an SDK in one agentic flow. |
| generate | gen | Generate TypeScript, Python, or Go SDK files. |
| validate | val | Validate OpenAPI or GraphQL specs. |
| config | | Create or inspect .gidevorc.json. |
| plugin | p | Run a loaded plugin. |
| login / logout / whoami | | Manage local API-token state. |
Agentic Workflow
doctor checks the local project without writing files:
gidevo-api-tool doctor --spec ./specs/api.yaml
gidevo-api-tool doctor --spec ./specs/api.yaml --jsonChecks include:
- Node runtime compatibility.
- Config-file validity.
- Plugin loading.
- Spec readability and validation.
- Output path safety.
workflow combines the most common local loop:
gidevo-api-tool workflow \
--spec ./specs/api.yaml \
--language typescript \
--output ./generatedSupported languages:
typescriptpythongo
Existing Direct Commands
gidevo-api-tool init --template openapi --output ./my-api
gidevo-api-tool validate ./specs/api.yaml --strict
gidevo-api-tool generate --spec ./specs/api.yaml --language go --output ./generatedConfig
Create a project config:
gidevo-api-tool config --initExample .gidevorc.json:
{
"generate": {
"spec": "./specs/api.yaml",
"language": "typescript",
"output": "./generated",
"allowOutsideProject": false
},
"validate": {
"strict": false
}
}Command-line flags override config values.
CI And Accessibility
Global flags:
--no-spinnerdisables animated spinners.--no-colordisables ANSI colors.--quietsuppresses banners and non-essential output.--jsonis available ondoctorandworkflowfor automation.
Path Safety
By default, spec and output paths must stay inside the current project root. Explicit overrides:
gidevo-api-tool generate --spec api.yaml --output ../external --allow-outside-project
GIDEVO_ALLOW_UNSAFE_PATHS=1 gidevo-api-tool workflow --spec api.yamlProgrammatic Usage
import { CodeGenerator, Validator } from 'gidevo-api-tool';
const validator = new Validator();
const result = await validator.validate('./specs/api.yaml', { strict: true });
if (result.valid) {
const generator = new CodeGenerator();
await generator.generate({
spec: './specs/api.yaml',
language: 'typescript',
outputDir: './generated',
});
}Development
npm install
npm run build
npm test -- --runInBand
npm run lint
npm run format:checkv0.2 Upgrade Notes
- Node 18 and Node 20 are no longer supported.
- The package is ESM-first.
- The CLI voice now uses clear developer terminology by default.
- New
doctorandworkflowcommands provide the agentic project loop.
