Skip to content

hesedcasa/api2cli

BranchesTags

Repository files navigation

api2cli

Import OpenAPI, Postman, and GraphQL specs and call their operations as native CLI commands

Version License Downloads/week

Usage

$ npm install -g @hesed/api2cli
$ api2cli COMMAND
running command...
$ api2cli (--version)
@hesed/api2cli/0.3.1 linux-x64 node-v22.22.3
$ api2cli --help [COMMAND]
USAGE
  $ api2cli COMMAND
...

Commands

api2cli api:auth:add API

Add an auth profile for an imported API

USAGE
  $ api2cli api:auth:add API --type none|bearer|apikey|basic|custom [--api-key <value>] [--api-key-header <value>]
    [--base-url <value>] [--header <value>...] [--password <value>] [-p <value>] [--token <value>] [--username <value>]

ARGUMENTS
  API  API name

FLAGS
  -p, --profile=<value>         [default: default] Profile name
      --api-key=<value>         API key value (used with --type apikey)
      --api-key-header=<value>  [default: X-API-Key] Header name for the API key
      --base-url=<value>        Base URL for this profile (overrides spec base URL at call time)
      --header=<value>...       Custom header Key=Value (--type custom, repeatable)
      --password=<value>        Password for basic auth
      --token=<value>           Bearer token (used with --type bearer)
      --type=<option>           (required) Auth type
                                <options: none|bearer|apikey|basic|custom>
      --username=<value>        Username for basic auth

DESCRIPTION
  Add an auth profile for an imported API

EXAMPLES
  $ api2cli api auth add petstore --type bearer --token sk-...

  $ api2cli api auth add petstore --type apikey --api-key mykey -p prod

  $ api2cli api auth add petstore --type basic --username user --password secret

  $ api2cli api auth add petstore --type custom --header X-Tenant-ID=acme --header X-App-Key=secret

  $ api2cli api auth add petstore --type bearer --token sk-... --base-url https://api.prod.example.com

  $ api2cli api auth add petstore --type none

See code: src/commands/api/auth/add.ts

api2cli api:auth:delete API

Delete an auth profile for an imported API

USAGE
  $ api2cli api:auth:delete API [-p <value>]

ARGUMENTS
  API  API name

FLAGS
  -p, --profile=<value>  [default: default] Profile name to delete

DESCRIPTION
  Delete an auth profile for an imported API

EXAMPLES
  $ api2cli api auth delete petstore

  $ api2cli api auth delete petstore -p prod

See code: src/commands/api/auth/delete.ts

api2cli api:auth:list API

List auth profiles for an imported API

USAGE
  $ api2cli api:auth:list API

ARGUMENTS
  API  API name

DESCRIPTION
  List auth profiles for an imported API

EXAMPLES
  $ api2cli api auth list petstore

See code: src/commands/api/auth/list.ts

api2cli api:auth:profile API

Get or set the default auth profile for an imported API

USAGE
  $ api2cli api:auth:profile API [--default <value>]

ARGUMENTS
  API  API name

FLAGS
  --default=<value>  Profile to set as default

DESCRIPTION
  Get or set the default auth profile for an imported API

EXAMPLES
  $ api2cli api auth profile petstore

  $ api2cli api auth profile petstore --default prod

See code: src/commands/api/auth/profile.ts

api2cli api:auth:update API

Update an auth profile for an imported API

USAGE
  $ api2cli api:auth:update API --type none|bearer|apikey|basic|custom [--api-key <value>] [--api-key-header <value>]
    [--base-url <value>] [--header <value>...] [--password <value>] [-p <value>] [--token <value>] [--username <value>]

ARGUMENTS
  API  API name

FLAGS
  -p, --profile=<value>         [default: default] Profile name
      --api-key=<value>         API key value (used with --type apikey)
      --api-key-header=<value>  [default: X-API-Key] Header name for the API key
      --base-url=<value>        Base URL for this profile (overrides spec base URL at call time)
      --header=<value>...       Custom header Key=Value (--type custom, repeatable)
      --password=<value>        Password for basic auth
      --token=<value>           Bearer token (used with --type bearer)
      --type=<option>           (required) Auth type
                                <options: none|bearer|apikey|basic|custom>
      --username=<value>        Username for basic auth

DESCRIPTION
  Update an auth profile for an imported API

EXAMPLES
  $ api2cli api auth update petstore --type bearer --token sk-new

  $ api2cli api auth update petstore --type apikey --api-key newkey -p prod

  $ api2cli api auth update petstore --type bearer --token sk-... --base-url https://api.prod.example.com -p prod

See code: src/commands/api/auth/update.ts

api2cli api:call NAME OPERATIONID

Call an imported API operation

USAGE
  $ api2cli api:call NAME OPERATIONID [--base-url <value>] [--body <value>...] [--header <value>...] [--param
    <value>...] [-p <value>] [--raw] [--toon]

ARGUMENTS
  NAME         API name (as shown in 'api list')
  OPERATIONID  Operation ID to call (as shown in `api list <name>`)

FLAGS
  -p, --profile=<value>    Authentication profile name
      --base-url=<value>   Override the base URL for this request
      --body=<value>...    Request body field as key=value (repeatable)
      --header=<value>...  Extra request header as Key=Value (repeatable)
      --param=<value>...   Path or query parameter as key=value (repeatable)
      --raw                Print the raw response body without JSON formatting
      --toon               Encode JSON output with TOON for token-efficient LLM consumption

DESCRIPTION
  Call an imported API operation

EXAMPLES
  $ api2cli api call petstore listPets

  $ api2cli api call petstore getPetById --param petId=42

  $ api2cli api call petstore createPet --body name=Fido --body tag=dog

  $ api2cli api call petstore listPets --query limit=10 --header X-Trace=abc

See code: src/commands/api/call.ts

api2cli api:config NAME

Update configuration for an imported API spec

USAGE
  $ api2cli api:config NAME [--base-url <value>] [--description <value>] [--insecure] [--rename <value>]
    [--title <value>]

ARGUMENTS
  NAME  API name (as shown in `api list`)

FLAGS
  --base-url=<value>     New base URL for API calls
  --description=<value>  New description for the spec
  --[no-]insecure        Skip TLS certificate verification (--no-insecure to disable)
  --rename=<value>       New short identifier for this API
  --title=<value>        New display title for the spec

DESCRIPTION
  Update configuration for an imported API spec

EXAMPLES
  $ api2cli api config petstore --base-url https://api.example.com

  $ api2cli api config petstore --rename mystore

  $ api2cli api config petstore --title "My Petstore" --description "A pet store API"

See code: src/commands/api/config.ts

api2cli api:import SOURCE

Import an OpenAPI spec, Postman collection, or GraphQL schema (SDL/introspection/endpoint) and register its operations as commands

USAGE
  $ api2cli api:import SOURCE [--api-key <value>] [--api-key-header <value>] [--auth-type
    none|bearer|apikey|basic] [--base-url <value>] [--graphql] [--insecure] [--name <value>] [--password <value>]
    [--selection-depth <value>] [--token <value>] [--username <value>]

ARGUMENTS
  SOURCE  Path to a local OpenAPI/Postman/GraphQL spec or URL (REST or GraphQL endpoint)

FLAGS
  --api-key=<value>          API key value (used with --auth-type apikey)
  --api-key-header=<value>   [default: X-API-Key] Header name for the API key
  --auth-type=<option>       Authentication type
                             <options: none|bearer|apikey|basic>
  --base-url=<value>         Override the base URL for API calls
  --graphql                  Treat the source as a GraphQL schema (SDL, introspection JSON, or live endpoint)
  --insecure                 Skip TLS certificate verification (for self-signed certs)
  --name=<value>             Short identifier for this API (defaults to title slug)
  --password=<value>         Password for basic auth
  --selection-depth=<value>  [default: 3] Max depth of auto-generated GraphQL selection sets (GraphQL imports only)
  --token=<value>            Bearer token (used with --auth-type bearer)
  --username=<value>         Username for basic auth

DESCRIPTION
  Import an OpenAPI spec, Postman collection, or GraphQL schema (SDL/introspection/endpoint) and register its operations
  as commands

EXAMPLES
  $ api2cli api import ./petstore.json  --name petstore

  $ api2cli api import ./postman_collection.json --name myapi

  $ api2cli api import https://petstore3.swagger.io/api/v3/openapi.json

  $ api2cli api import ./schema.graphql --base-url https://api.example.com/graphql

  $ api2cli api import https://api.example.com/graphql --name github

  $ api2cli api import ./api.yaml --auth-type bearer --token sk-...

  $ api2cli api import ./api.yaml --auth-type apikey --api-key mykey --api-key-header X-API-Key

  $ api2cli api import ./api.yaml --auth-type basic --username user --password pass

See code: src/commands/api/import.ts

api2cli api:list [NAME]

List imported API specs and their available operations

USAGE
  $ api2cli api:list [NAME]

ARGUMENTS
  [NAME]  API name to list operations for (omit to list all imported APIs)

DESCRIPTION
  List imported API specs and their available operations

EXAMPLES
  $ api2cli api list

  $ api2cli api list petstore

See code: src/commands/api/list.ts

api2cli api:remove NAME

Remove an imported API spec

USAGE
  $ api2cli api:remove NAME

ARGUMENTS
  NAME  API name to remove

DESCRIPTION
  Remove an imported API spec

EXAMPLES
  $ api2cli api remove petstore

See code: src/commands/api/remove.ts

About

Import OpenAPI, Postman, and GraphQL specs and call their operations as native CLI commands

Resources

Readme

License

Apache-2.0 license
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases 3

v0.3.1 Latest
Jun 5, 2026
+ 2 releases

Packages

 
 
 

Contributors

Languages