{ "commands": { "delete": { "aliases": [], "args": { "endpoint": { "description": "name of the endpoint (e.g. api/customers)", "name": "endpoint", "required": true } }, "description": "Delete an endpoint from your StepZen account.", "flags": { "help": { "char": "h", "description": "Show CLI help", "name": "help", "allowNo": false, "type": "boolean" }, "non-interactive": { "description": "Disable all interactive prompts", "name": "non-interactive", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "delete", "pluginAlias": "stepzen", "pluginName": "stepzen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "lib", "commands", "delete.js" ] }, "deploy": { "aliases": [], "args": { "endpoint": { "description": "name of the endpoint (e.g. api/customers)\n [default: use the endpoint property from stepzen.config.json]", "name": "endpoint", "required": false } }, "description": "Deploy to StepZen.", "flags": { "help": { "char": "h", "description": "Show CLI help", "name": "help", "allowNo": false, "type": "boolean" }, "non-interactive": { "description": "Disable all interactive prompts", "name": "non-interactive", "allowNo": false, "type": "boolean" }, "dir": { "description": "Working directory", "name": "dir", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "silent": { "name": "silent", "allowNo": false, "type": "boolean" }, "configurationsets": { "description": "\n Name(s) of configuration sets uploaded earlier with stepzen upload\n [DEPRECATED: this flag will be removed in future versions]\n \n Instead, please use one of these options:\n - stepzen deploy (without the --configurationsets flag)\n \tto use the configuration from the config.yaml file in the current directory (if exists)\n - stepzen deploy --config path/to/config.yaml\n \tto explicitly specify the configuration file", "exclusive": [ "config", "dir" ], "name": "configurationsets", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "config": { "description": "[default: config.yaml] Configuration file to use (relative to the current directory)", "name": "config", "hasDynamicHelp": false, "helpValue": "path/to/config.yaml", "multiple": false, "type": "option" }, "schema": { "description": "\n Name of a schema uploaded earlier with stepzen upload\n [DEPRECATED: this flag will be removed in future versions]\n \n Instead, please use one of these options:\n - stepzen deploy (without the --schema flag)\n \tto deploy the schema from a StepZen workspace in your current directory\n - stepzen deploy --dir path/to/workspace\n \tto deploy from a StepZen workspace in another folder", "exclusive": [ "config", "dir" ], "name": "schema", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "deploy", "pluginAlias": "stepzen", "pluginName": "stepzen", "pluginType": "core", "strict": true, "usage": "deploy [ENDPOINT] [--config=path/to/config.yaml] [--dir=path/to/workspace]\n\n-- OR (deprecated) --\n\n$ stepzen deploy ENDPOINT --schema=schema [--configurationsets=cs1[,cs2[,..]]]", "enableJsonFlag": false, "isESM": true, "relativePath": [ "lib", "commands", "deploy.js" ] }, "init": { "aliases": [], "args": { "directory": { "hidden": true, "name": "directory" } }, "description": "Initialize a StepZen workspace in the current directory.", "flags": { "help": { "char": "h", "description": "Show CLI help", "name": "help", "allowNo": false, "type": "boolean" }, "non-interactive": { "description": "Disable all interactive prompts", "name": "non-interactive", "allowNo": false, "type": "boolean" }, "endpoint": { "description": "Endpoint name (e.g. api/myapp)", "name": "endpoint", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "description": "Accept default answers to interactive prompts", "name": "yes", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "init", "pluginAlias": "stepzen", "pluginName": "stepzen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "lib", "commands", "init.js" ] }, "lint": { "aliases": [], "args": {}, "description": "StepZen lint.", "flags": { "help": { "char": "h", "description": "Show CLI help", "name": "help", "allowNo": false, "type": "boolean" }, "non-interactive": { "description": "Disable all interactive prompts", "name": "non-interactive", "allowNo": false, "type": "boolean" }, "dir": { "hidden": true, "name": "dir", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "lint", "pluginAlias": "stepzen", "pluginName": "stepzen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "lib", "commands", "lint.js" ] }, "list": { "aliases": [], "args": { "type": { "default": "endpoints", "description": "\n\n The type of entities to list:\n \tendpoints - GraphQL API endpoints deployed with stepzen deploy (or stepzen start)", "name": "type" } }, "description": "List endpoints, schemas and configuration sets in your StepZen account.\nAll timestamps displayed by stepzen list endpoints are in your local time zone.", "flags": { "help": { "char": "h", "description": "Show CLI help", "name": "help", "allowNo": false, "type": "boolean" }, "non-interactive": { "description": "Disable all interactive prompts", "name": "non-interactive", "allowNo": false, "type": "boolean" }, "folder": { "description": "Filter the list to only show endpoints within a specific folder. example usage --folder folder_name or --folder !folder_name", "name": "folder", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "description": "Filter the list to only show endpoints with a specific name. example usage --name endpoint_name or --name '!endpoint_name'", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "list", "pluginAlias": "stepzen", "pluginName": "stepzen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "lib", "commands", "list.js" ] }, "login": { "aliases": [], "args": { "domain": { "description": "Domain of the StepZen service to login to (e.g. us-east-a.ibm.stepzen.net or eu-central-a.ibm.stepzen.net). If no domain is provided, stepzen.net is used by default. Check you domain from the StepZen Dashboard.", "name": "domain", "required": false } }, "description": "Log in to StepZen.", "flags": { "help": { "char": "h", "description": "Show CLI help", "name": "help", "allowNo": false, "type": "boolean" }, "non-interactive": { "description": "Disable all interactive prompts", "name": "non-interactive", "allowNo": false, "type": "boolean" }, "account": { "char": "a", "description": "StepZen account name (copy from https://stepzen.com/account). If not provided, the CLI prompts the users to enter one.", "exclusive": [ "config" ], "name": "account", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "adminkey": { "char": "k", "description": "Key used for authentication. If used with `-i `, it is treated as the API key for the instance (get it from https://aws.console.saas.ibm.com/ under \"API Keys\"). If used with `-a `, it is treated as the Admin key). If not provided, the CLI will prompt for it.", "exclusive": [ "config" ], "name": "adminkey", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "introspection": { "description": "Override the default StepZen introspection service URL for all stepzen import commands. If not provided, use the default introspection URL.\n\nExample:\nstepzen login --introspection stepzen-introspection.mydomain.com", "name": "introspection", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "instanceId": { "char": "i", "description": "Instance ID of your subscribed StepZen instance. You can find this in the SaaS console under Subscriptions → APIConnect for GraphQL → Instances.", "name": "instanceId", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "config": { "exclusive": [ "account", "adminkey" ], "hidden": true, "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "login", "pluginAlias": "stepzen", "pluginName": "stepzen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "lib", "commands", "login.js" ] }, "logout": { "aliases": [], "args": {}, "description": "Log out of StepZen.", "flags": { "help": { "char": "h", "description": "Show CLI help", "name": "help", "allowNo": false, "type": "boolean" }, "non-interactive": { "description": "Disable all interactive prompts", "name": "non-interactive", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "logout", "pluginAlias": "stepzen", "pluginName": "stepzen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "lib", "commands", "logout.js" ] }, "request": { "aliases": [], "args": { "query": { "description": "GraphQL query (could include a query, a mutation or a subscription).\nThis argument is required unless you provide the query as a file with --file=file.", "name": "query" } }, "description": "Send a GraphQL request to a StepZen endpoint and print the response, using the API key and the target endpoint from the current StepZen workspace.", "flags": { "help": { "char": "h", "description": "Show CLI help", "name": "help", "allowNo": false, "type": "boolean" }, "non-interactive": { "description": "Disable all interactive prompts", "name": "non-interactive", "allowNo": false, "type": "boolean" }, "dir": { "description": "StepZen workspace directory (defaults to the current directory)", "exclusive": [ "endpoint" ], "name": "dir", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "endpoint": { "description": "StepZen endpoint to call (defaults to the endpoint in current StepZen workspace)", "exclusive": [ "dir" ], "name": "endpoint", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "header": { "char": "H", "description": "Add an additional HTTP header to the request. This is useful for schemas where @rest or @graphql directives enable header forwarding with forwardheaders.\n\nExample:\nstepzen request '{ user(id: \"u123\") { email } }' \\\n\t-H \"X-API-Token: SecretAPIToken\"\n\nUse the -H \"Header-Name:\" syntax to drop a default header, and the -H \"Header-Name;\" syntax to send a header with an empty value.", "name": "header", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "operation-name": { "description": "Specify the operation name (in case if the provided query includes multiple operations)", "name": "operation-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "var": { "description": "Add a request variable, in the name=value format.\n\nExample:\nstepzen request 'query OrdersQuery($search: String!, $limit: Int) {\n\t\torders(search: $search, limit: $limit) { id createdAt }\n\t}' \\\n\t--var 'search=space ninja' \\\n\t--var limit=5", "name": "var", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "var-file": { "description": "Read request variables from a JSON file. In case when the same variable value is provided both via --var-file and --var, the priority is given to the latter.\n\nExample:\nstepzen request 'query OrdersQuery($search: String!, $limit: Int) {\n\t\torders(search: $search, limit: $limit) { id createdAt }\n\t}' \\\n\t--var-file ./vars.json", "name": "var-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "file": { "char": "f", "description": "Read the query text from a file instead of the command line.\n\nExample:\nstepzen request -f query.graphql", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "request", "pluginAlias": "stepzen", "pluginName": "stepzen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "lib", "commands", "request.js" ] }, "service": { "aliases": [], "args": { "action": { "description": "\n \tstart\tstart a local StepZen service instance in a Docker container\n \t\tThis command pulls the latest StepZen service instance Docker image so that the\n \t\tversion of StepZen you run locally is the same as the one running on\n \t\tstepzen.net.\n \n \tstop\tstop the local StepZen service instance (if running)\n \t\tThis command deletes the Docker container with the StepZen service instance,\n \t\tbut all your endpoints are persistently stored in the metadata database. They\n \t\tremain available when running stepzen service start next time.\n \n \tupgrade\tupgrade the local StepZen service instance if it is running\n \t\tThis command checks if a newer version of the StepZen service instance Docker\n \t\timage is available, and if it is then stops and deletes the currently running\n \t\tcontainer, pulls the latest image, and starts it. All endpoints are preserved.\n\n If no action is provided, print the service status and exit.", "name": "action", "options": [ "start", "stop", "upgrade" ], "required": false } }, "description": "Manage the local StepZen service instance (requires Docker).\nYou can use a local StepZen service instance instead of the StepZen cloud to develop and test GraphQL endpoints locally. This way you can try StepZen out without giving the StepZen cloud access to your data sources and API endpoints.\n\nLocal StepZen service instances are not suitable for production use. Please refer to the documentation at https://stepzen.com/docs/deployment/local-docker for more information and examples.", "flags": { "help": { "char": "h", "description": "Show CLI help", "name": "help", "allowNo": false, "type": "boolean" }, "non-interactive": { "description": "Disable all interactive prompts", "name": "non-interactive", "allowNo": false, "type": "boolean" }, "dsn": { "description": "DSN of a StepZen metadata database, e.g. postgres://user:password@172.17.0.1:5432/zenctl", "exclusive": [ "reset-auto", "prompt" ], "name": "dsn", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "reset-auto": { "description": "Create fresh empty metadata database. Note: all existing endpoints will be deleted and you will be logged out.", "exclusive": [ "dsn", "prompt" ], "name": "reset-auto", "allowNo": false, "type": "boolean" }, "prompt": { "description": "Opens an interactive prompt to ask for database details (or fails, if running in a non-interactive mode).", "exclusive": [ "dsn", "non-interactive" ], "name": "prompt", "allowNo": false, "type": "boolean" }, "port": { "description": "Override the TCP port on which the local StepZen service instance will listen for connections (port 9000 by default).", "name": "port", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env": { "description": "Pass additional environment variables to the docker container", "hidden": true, "name": "env", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "driver-path": { "description": "(Optional) Mount a local directory containing additional JDBC drivers to the API Connect Essentials Docker container for the introspection service. This setup is required when JDBC driver licenses restrict the distribution of certain drivers (such as those for Db2 and Oracle) along with the API Connect Essentials Docker image.\n \n Example: stepzen service start --driver-path \"path1\" --driver-path \"path2\"", "name": "driver-path", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "service", "pluginAlias": "stepzen", "pluginName": "stepzen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "lib", "commands", "service.js" ] }, "start": { "aliases": [], "args": {}, "description": "Deploy your schema to StepZen, and then redeploy on every change.", "flags": { "help": { "char": "h", "description": "Show CLI help", "name": "help", "allowNo": false, "type": "boolean" }, "non-interactive": { "description": "Disable all interactive prompts", "name": "non-interactive", "allowNo": false, "type": "boolean" }, "dir": { "description": "Working directory", "name": "dir", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "endpoint": { "description": "Override workspace endpoint", "name": "endpoint", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dashboard": { "description": "Which GraphiQL dashboard to use to explore the deployed endpoint.\n\t- web [default]: use GraphiQL at dashboard.stepzen.com\n\t- local: start a local GraphiQL dashboard on localhost:5001 (change the port with the --port flag)\n\t- none: do not use GraphiQL at all", "name": "dashboard", "hasDynamicHelp": false, "multiple": false, "options": [ "web", "local", "none" ], "type": "option" }, "port": { "description": "Port for the local GraphiQL dashboard (when using --dashboard=local)", "env": "PORT", "name": "port", "default": 5001, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-console": { "hidden": true, "name": "no-console", "allowNo": false, "type": "boolean" }, "no-dashboard": { "hidden": true, "name": "no-dashboard", "allowNo": false, "type": "boolean" }, "no-init": { "hidden": true, "name": "no-init", "allowNo": false, "type": "boolean" }, "no-validate": { "hidden": true, "name": "no-validate", "allowNo": false, "type": "boolean" }, "no-watcher": { "hidden": true, "name": "no-watcher", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "start", "pluginAlias": "stepzen", "pluginName": "stepzen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "lib", "commands", "start.js" ] }, "transpile": { "aliases": [], "args": { "folder": { "name": "folder", "required": true } }, "description": "Transpile a GraphQL schema.", "flags": { "help": { "char": "h", "description": "Show CLI help", "name": "help", "allowNo": false, "type": "boolean" }, "non-interactive": { "description": "Disable all interactive prompts", "name": "non-interactive", "allowNo": false, "type": "boolean" }, "config": { "hidden": true, "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "hide-output": { "hidden": true, "name": "hide-output", "allowNo": false, "type": "boolean" }, "inspect": { "char": "i", "hidden": true, "name": "inspect", "allowNo": false, "type": "boolean" }, "inspect-after": { "hidden": true, "name": "inspect-after", "allowNo": false, "type": "boolean" }, "output-configuration": { "name": "output-configuration", "allowNo": false, "type": "boolean" }, "silent": { "name": "silent", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "transpile", "pluginAlias": "stepzen", "pluginName": "stepzen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "lib", "commands", "transpile.js" ] }, "validate": { "aliases": [], "args": { "folder": { "name": "folder", "required": true } }, "description": "Validate a GraphQL schema.", "flags": { "help": { "char": "h", "description": "Show CLI help", "name": "help", "allowNo": false, "type": "boolean" }, "non-interactive": { "description": "Disable all interactive prompts", "name": "non-interactive", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "validate", "pluginAlias": "stepzen", "pluginName": "stepzen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "lib", "commands", "validate.js" ] }, "whoami": { "aliases": [], "args": {}, "description": "View your StepZen credentials.", "flags": { "help": { "char": "h", "description": "Show CLI help", "name": "help", "allowNo": false, "type": "boolean" }, "non-interactive": { "description": "Disable all interactive prompts", "name": "non-interactive", "allowNo": false, "type": "boolean" }, "showkeys": { "exclusive": [ "account", "adminkey", "apikey", "domain", "instanceid", "email", "accesstoken" ], "name": "showkeys", "allowNo": false, "type": "boolean" }, "account": { "exclusive": [ "showkeys", "adminkey", "apikey", "domain", "instanceid", "email", "accesstoken" ], "name": "account", "allowNo": false, "type": "boolean" }, "adminkey": { "exclusive": [ "showkeys", "account", "apikey", "domain", "instanceid", "email", "accesstoken" ], "name": "adminkey", "allowNo": false, "type": "boolean" }, "apikey": { "exclusive": [ "showkeys", "account", "adminkey", "domain", "instanceid", "email", "accesstoken" ], "name": "apikey", "allowNo": false, "type": "boolean" }, "domain": { "exclusive": [ "showkeys", "account", "adminkey", "apikey", "instanceid", "email", "accesstoken" ], "name": "domain", "allowNo": false, "type": "boolean" }, "instanceid": { "exclusive": [ "showkeys", "account", "adminkey", "apikey", "domain", "email", "accesstoken" ], "name": "instanceid", "allowNo": false, "type": "boolean" }, "email": { "exclusive": [ "showkeys", "account", "adminkey", "apikey", "domain", "instanceid", "accesstoken" ], "name": "email", "allowNo": false, "type": "boolean" }, "accesstoken": { "exclusive": [ "showkeys", "account", "adminkey", "apikey", "domain", "instanceid", "email" ], "name": "accesstoken", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "whoami", "pluginAlias": "stepzen", "pluginName": "stepzen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "lib", "commands", "whoami.js" ] }, "import:curl": { "aliases": [], "args": {}, "description": "Import a schema for a REST endpoint into your GraphQL API (uses the curl syntax).\n\nstepzen import curl automatically introspects a REST endpoint, generates a GraphQL schema for accessing this endpoint through a StepZen API, and adds the generated types and a query field into your GraphQL schema.", "flags": { "help": { "char": "h", "description": "Show CLI help", "name": "help", "allowNo": false, "type": "boolean" }, "non-interactive": { "description": "Disable all interactive prompts", "name": "non-interactive", "allowNo": false, "type": "boolean" }, "dir": { "description": "Working directory", "name": "dir", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "silent": { "description": "This is an internal flag passed by the (no-arg) Import command when it launches a data-source specific import command. The intent is to avoid showing a welcome message twice (if its already been shown by the (no-arg) Import command).", "hidden": true, "name": "silent", "allowNo": false, "type": "boolean" }, "name": { "description": "Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported schema.", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "overwrite": { "dependsOn": [ "name" ], "description": "Overwrite any existing schema with the same name. Cannot be used without also providing a --name flag.", "hidden": true, "name": "overwrite", "allowNo": false, "type": "boolean" }, "prefix": { "description": "Prefix to add to every type in the generated schema", "name": "prefix", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "data": { "aliases": [ "data-ascii", "data-raw", "data-binary" ], "char": "d", "hidden": true, "name": "data", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "request": { "char": "X", "hidden": true, "name": "request", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "url": { "hidden": true, "name": "url", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "header": { "char": "H", "description": "Specifies a request header to pass\n\nExample:\nstepzen import curl https://example.com/api/customers \\\n\t-H \"Authorization: apikey SecretAPIKeyValue\"", "name": "header", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "header-param": { "description": "Specifies a parameter in a header value. Can be formed by taking a -H, --header flag and replacing the variable part of the header value with a $paramName placeholder. Repeat this flag once for each header with a parameter.\n\nExample:\nstepzen import curl https://example.com/api/customers \\\n\t-H \"Authorization: apikey SecretAPIKeyValue\" \\\n\t--header-param 'Authorization: apikey $apikey'", "name": "header-param", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "query-name": { "description": "Property name to add to the Query type as a way to access the imported endpoint", "name": "query-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "query-type": { "description": "Name for the type returned by the curl request in the generated schema. The name specified by --query-type is not prefixed by --prefix if both flags are present.", "name": "query-type", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "path-params": { "description": "Specifies path parameters in the URL path. Can be formed by taking the original path and replacing the variable segments with $paramName placeholders.\n\nExample:\nstepzen import curl https://example.com/users/jane/posts/12 --path-params '/users/$userId/posts/$postId'", "name": "path-params", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "secrets": { "description": "Specifies the names of HTTP headers whose values are considered secrets.\nA header's value is replaced with an expansion variable which is set in config.yaml\n\nExample:\nstepzen import curl https://stepzen.us-east-a.ibm.stepzen.net/version \\\n\t--header 'Authorization: ' \\\n\t--secrets 'Authorization'\n\nThis ensures that sensitive values are securely stored in generated config.yaml\n\n### Example config.yaml outputs:\n```yaml\nconfigurationset:\n - configuration:\n authorization_416efbc0dc: Apikey \n name: curl_import_config\n```\n\nIn this case, index.graphql must reference \"$authorization_416efbc0dc;\".\n\n**headers: [{ name: \"authorization\", value: \"$authorization_416efbc0dc;\" }]", "name": "secrets", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "import:curl", "pluginAlias": "stepzen", "pluginName": "stepzen", "pluginType": "core", "strict": false, "enableJsonFlag": false, "isESM": true, "relativePath": [ "lib", "commands", "import", "curl.js" ] }, "import:db2": { "aliases": [], "args": { "jdbcUrl": { "description": "(optional) JDBC URL of a Db2 database.\nExample: 'jdbc:db2://host:port/db:user=username;password=password;schema=schema;sslConnection=true/false;'\n\nThe --db-schema flag overrides the schema part of the JDBC URL (if both are provided).", "name": "jdbcUrl" } }, "description": "Import a schema for a Db2 data source into your GraphQL API.\n\nstepzen import db2 automatically introspects a Db2 database, generates a GraphQL schema for accessing this database through a StepZen API, and merges the generated types, queries and mutations into your GraphQL schema.", "flags": { "help": { "char": "h", "description": "Show CLI help", "name": "help", "allowNo": false, "type": "boolean" }, "non-interactive": { "description": "Disable all interactive prompts", "name": "non-interactive", "allowNo": false, "type": "boolean" }, "dir": { "description": "Working directory", "name": "dir", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "silent": { "description": "This is an internal flag passed by the (no-arg) Import command when it launches a data-source specific import command. The intent is to avoid showing a welcome message twice (if its already been shown by the (no-arg) Import command).", "hidden": true, "name": "silent", "allowNo": false, "type": "boolean" }, "name": { "description": "Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported schema.", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "overwrite": { "dependsOn": [ "name" ], "description": "Overwrite any existing schema with the same name. Cannot be used without also providing a --name flag.", "hidden": true, "name": "overwrite", "allowNo": false, "type": "boolean" }, "db-schema": { "description": "Database schema to import tables from (default: public)", "name": "db-schema", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "db-link-types": { "description": "Automatically link types based on foreign key relationships using @materializer (https://stepzen.com/docs/features/linking-types)", "name": "db-link-types", "allowNo": false, "type": "boolean" }, "db-include": { "description": "Should the generated GraphQL schema be based only on database views, only on tables or on both", "name": "db-include", "hasDynamicHelp": false, "multiple": false, "options": [ "tables-only", "views-only", "tables-and-views" ], "type": "option" }, "db-use-deprecated-2022-naming": { "description": "Use the deprecated pre-2023 naming convention in the generated GraphQL schema:\n\t- the generated type and property names are auto-capitalized into PascalCase\n\t- the generated field names use the getCustomer and getCustomerList style.\n\nOn the other hand, when using the default naming convention:\n\t- the generated type and property names match exactly the DB table and column names\n\t- the generated field names use the customer and customerList style.", "name": "db-use-deprecated-2022-naming", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "import:db2", "pluginAlias": "stepzen", "pluginName": "stepzen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "lib", "commands", "import", "db2.js" ] }, "import:flow": { "aliases": [], "args": { "flow": { "name": "flow" } }, "description": "Import StepZen flow expression as a query field into your GraphQL API.\n\nstepzen import flow automatically introspects a GraphQL endpoint and adds a @sequence implementing the given flow expression into your GraphQL schema.", "flags": { "help": { "char": "h", "description": "Show CLI help", "name": "help", "allowNo": false, "type": "boolean" }, "non-interactive": { "description": "Disable all interactive prompts", "name": "non-interactive", "allowNo": false, "type": "boolean" }, "dir": { "description": "Working directory", "name": "dir", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "silent": { "description": "This is an internal flag passed by the (no-arg) Import command when it launches a data-source specific import command. The intent is to avoid showing a welcome message twice (if its already been shown by the (no-arg) Import command).", "hidden": true, "name": "silent", "allowNo": false, "type": "boolean" }, "name": { "description": "Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported schema.", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "overwrite": { "dependsOn": [ "name" ], "description": "Overwrite any existing schema with the same name. Cannot be used without also providing a --name flag.", "hidden": true, "name": "overwrite", "allowNo": false, "type": "boolean" }, "header": { "char": "H", "dependsOn": [ "endpoint" ], "description": "Specifies a request header to pass\n\nExample:\nstepzen import curl https://example.com/api/customers \\\n\t-H \"Authorization: apikey SecretAPIKeyValue\"", "name": "header", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "endpoint": { "description": "Use a custom GraphQL schema instead of the project's schema as the schema providing the steps in the flow.", "name": "endpoint", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "import:flow", "pluginAlias": "stepzen", "pluginName": "stepzen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "lib", "commands", "import", "flow.js" ] }, "import:graphql": { "aliases": [], "args": { "url": { "name": "url" } }, "description": "Import a GraphQL API as a subgraph into your GraphQL API.\n\nstepzen import graphql automatically introspects a GraphQL endpoint and merges the types, queries, mutations and subscriptions for accessing this endpoint through a StepZen API into your GraphQL schema.", "flags": { "help": { "char": "h", "description": "Show CLI help", "name": "help", "allowNo": false, "type": "boolean" }, "non-interactive": { "description": "Disable all interactive prompts", "name": "non-interactive", "allowNo": false, "type": "boolean" }, "dir": { "description": "Working directory", "name": "dir", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "silent": { "description": "This is an internal flag passed by the (no-arg) Import command when it launches a data-source specific import command. The intent is to avoid showing a welcome message twice (if its already been shown by the (no-arg) Import command).", "hidden": true, "name": "silent", "allowNo": false, "type": "boolean" }, "name": { "description": "Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported schema.", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "overwrite": { "dependsOn": [ "name" ], "description": "Overwrite any existing schema with the same name. Cannot be used without also providing a --name flag.", "hidden": true, "name": "overwrite", "allowNo": false, "type": "boolean" }, "prefix": { "description": "Prefix to add to every type in the generated schema", "name": "prefix", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "header": { "char": "H", "description": "Specifies a request header to pass\n\nExample:\nstepzen import curl https://example.com/api/customers \\\n\t-H \"Authorization: apikey SecretAPIKeyValue\"", "name": "header", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "header-param": { "description": "Specifies a parameter in a header value. Can be formed by taking a -H, --header flag and replacing the variable part of the header value with a $paramName placeholder. Repeat this flag once for each header with a parameter.\n\nExample:\nstepzen import curl https://example.com/api/customers \\\n\t-H \"Authorization: apikey SecretAPIKeyValue\" \\\n\t--header-param 'Authorization: apikey $apikey'", "name": "header-param", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "secrets": { "description": "Specifies the names of HTTP headers whose values are considered secrets.\nA header's value is replaced with an expansion variable which is set in config.yaml\n\nExample:\nstepzen import curl https://stepzen.us-east-a.ibm.stepzen.net/version \\\n\t--header 'Authorization: ' \\\n\t--secrets 'Authorization'\n\nThis ensures that sensitive values are securely stored in generated config.yaml\n\n### Example config.yaml outputs:\n```yaml\nconfigurationset:\n - configuration:\n authorization_416efbc0dc: Apikey \n name: curl_import_config\n```\n\nIn this case, index.graphql must reference \"$authorization_416efbc0dc;\".\n\n**headers: [{ name: \"authorization\", value: \"$authorization_416efbc0dc;\" }]", "name": "secrets", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "import:graphql", "pluginAlias": "stepzen", "pluginName": "stepzen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "lib", "commands", "import", "graphql.js" ] }, "import": { "aliases": [], "args": { "source": { "description": "kind of the data source: curl, graphql, mysql, postgresql, snowflake, db2, oracle (or a full DSN string)", "name": "source" } }, "description": "Import a schema for an external data source or an API endpoint into your GraphQL API.\nSee more details with stepzen import [SOURCE] --help", "flags": { "help": { "char": "h", "description": "Show CLI help", "name": "help", "allowNo": false, "type": "boolean" }, "non-interactive": { "description": "Disable all interactive prompts", "name": "non-interactive", "allowNo": false, "type": "boolean" }, "dir": { "description": "Working directory", "name": "dir", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "import", "pluginAlias": "stepzen", "pluginName": "stepzen", "pluginType": "core", "strict": false, "enableJsonFlag": false, "isESM": true, "relativePath": [ "lib", "commands", "import", "index.js" ] }, "import:mysql": { "aliases": [ "import:singlestore" ], "args": { "dsn": { "description": "(optional) Data Source Name (DSN) of a MySQL database.\nExample: mysql://user:password@host:port/database\n\nFlags, such as --db-host, override the corresponding parts of the DSN (if both are provided).", "name": "dsn" } }, "description": "Import a schema for a MySQL data source into your GraphQL API.\n\nstepzen import mysql automatically introspects a MySQL database, generates a GraphQL schema for accessing this database through a StepZen API, and merges the generated types, queries and mutations into your into your GraphQL schema.", "flags": { "help": { "char": "h", "description": "Show CLI help", "name": "help", "allowNo": false, "type": "boolean" }, "non-interactive": { "description": "Disable all interactive prompts", "name": "non-interactive", "allowNo": false, "type": "boolean" }, "dir": { "description": "Working directory", "name": "dir", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "silent": { "description": "This is an internal flag passed by the (no-arg) Import command when it launches a data-source specific import command. The intent is to avoid showing a welcome message twice (if its already been shown by the (no-arg) Import command).", "hidden": true, "name": "silent", "allowNo": false, "type": "boolean" }, "name": { "description": "Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported schema.", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "overwrite": { "dependsOn": [ "name" ], "description": "Overwrite any existing schema with the same name. Cannot be used without also providing a --name flag.", "hidden": true, "name": "overwrite", "allowNo": false, "type": "boolean" }, "db-host": { "description": "Database host and optional port (as HOST[:PORT])", "name": "db-host", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "db-user": { "description": "Database user name", "name": "db-user", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "db-password": { "description": "Database password", "name": "db-password", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "db-database": { "description": "Name of database to import", "name": "db-database", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "db-link-types": { "description": "Automatically link types based on foreign key relationships using @materializer (https://stepzen.com/docs/features/linking-types)", "name": "db-link-types", "allowNo": false, "type": "boolean" }, "db-include": { "description": "Should the generated GraphQL schema be based only on database views, only on tables or on both", "name": "db-include", "hasDynamicHelp": false, "multiple": false, "options": [ "tables-only", "views-only", "tables-and-views" ], "type": "option" }, "db-use-deprecated-2022-naming": { "description": "Use the deprecated pre-2023 naming convention in the generated GraphQL schema:\n\t- the generated type and property names are auto-capitalized into PascalCase\n\t- the generated field names use the getCustomer and getCustomerList style.\n\nOn the other hand, when using the default naming convention:\n\t- the generated type and property names match exactly the DB table and column names\n\t- the generated field names use the customer and customerList style.", "name": "db-use-deprecated-2022-naming", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "import:mysql", "pluginAlias": "stepzen", "pluginName": "stepzen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "lib", "commands", "import", "mysql.js" ] }, "import:openapi": { "aliases": [], "args": { "openapi": { "name": "openapi" } }, "description": "Import a REST API from an OpenAPI spec as a subgraph into your GraphQL API.\n\nstepzen import openapi automatically introspects an OpenAPI spec file, generates a GraphQL schema for accessing the REST API it describes through a StepZen API, and adds the generated types, queries, mutations and subscriptions for accessing this REST API through a StepZen API into your GraphQL schema.", "flags": { "help": { "char": "h", "description": "Show CLI help", "name": "help", "allowNo": false, "type": "boolean" }, "non-interactive": { "description": "Disable all interactive prompts", "name": "non-interactive", "allowNo": false, "type": "boolean" }, "dir": { "description": "Working directory", "name": "dir", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "silent": { "description": "This is an internal flag passed by the (no-arg) Import command when it launches a data-source specific import command. The intent is to avoid showing a welcome message twice (if its already been shown by the (no-arg) Import command).", "hidden": true, "name": "silent", "allowNo": false, "type": "boolean" }, "name": { "description": "Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported schema.", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "overwrite": { "dependsOn": [ "name" ], "description": "Overwrite any existing schema with the same name. Cannot be used without also providing a --name flag.", "hidden": true, "name": "overwrite", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "import:openapi", "pluginAlias": "stepzen", "pluginName": "stepzen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "lib", "commands", "import", "openapi.js" ] }, "import:oracle": { "aliases": [], "args": { "jdbcUrl": { "description": "(optional) JDBC URL of an Oracle database.\nExample: 'jdbc:oracle:thin:user/password@//host:port/db?currentschema=schema'\n\nThe --db-schema flag overrides the schema part of the JDBC URL (if both are provided).", "name": "jdbcUrl" } }, "description": "Import a schema for a oracle data source into your GraphQL API.\n\nstepzen import oracle automatically introspects an Oracle database, generates a GraphQL schema for accessing this database through a StepZen API, and merges the generated types, queries and mutations into your GraphQL schema.", "flags": { "help": { "char": "h", "description": "Show CLI help", "name": "help", "allowNo": false, "type": "boolean" }, "non-interactive": { "description": "Disable all interactive prompts", "name": "non-interactive", "allowNo": false, "type": "boolean" }, "dir": { "description": "Working directory", "name": "dir", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "silent": { "description": "This is an internal flag passed by the (no-arg) Import command when it launches a data-source specific import command. The intent is to avoid showing a welcome message twice (if its already been shown by the (no-arg) Import command).", "hidden": true, "name": "silent", "allowNo": false, "type": "boolean" }, "name": { "description": "Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported schema.", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "overwrite": { "dependsOn": [ "name" ], "description": "Overwrite any existing schema with the same name. Cannot be used without also providing a --name flag.", "hidden": true, "name": "overwrite", "allowNo": false, "type": "boolean" }, "db-schema": { "description": "Database schema to import tables from (default: public)", "name": "db-schema", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "db-link-types": { "description": "Automatically link types based on foreign key relationships using @materializer (https://stepzen.com/docs/features/linking-types)", "name": "db-link-types", "allowNo": false, "type": "boolean" }, "db-include": { "description": "Should the generated GraphQL schema be based only on database views, only on tables or on both", "name": "db-include", "hasDynamicHelp": false, "multiple": false, "options": [ "tables-only", "views-only", "tables-and-views" ], "type": "option" }, "db-use-deprecated-2022-naming": { "description": "Use the deprecated pre-2023 naming convention in the generated GraphQL schema:\n\t- the generated type and property names are auto-capitalized into PascalCase\n\t- the generated field names use the getCustomer and getCustomerList style.\n\nOn the other hand, when using the default naming convention:\n\t- the generated type and property names match exactly the DB table and column names\n\t- the generated field names use the customer and customerList style.", "name": "db-use-deprecated-2022-naming", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "import:oracle", "pluginAlias": "stepzen", "pluginName": "stepzen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "lib", "commands", "import", "oracle.js" ] }, "import:postgresql": { "aliases": [ "import:postgres" ], "args": { "dsn": { "description": "(optional) Data Source Name (DSN) of a PostgreSQL database.\nExample: postgresql://user:password@host:port/database?schema=schema\n\nFlags, such as --db-host, override the corresponding parts of the DSN (if both are provided).", "name": "dsn" } }, "description": "Import a schema for a PostgreSQL data source into your GraphQL API.\n\nstepzen import postgresql automatically introspects a PostgreSQL database, generates a GraphQL schema for accessing this database through a StepZen API, and merges the generated types, queries and mutations into your GraphQL schema.", "flags": { "help": { "char": "h", "description": "Show CLI help", "name": "help", "allowNo": false, "type": "boolean" }, "non-interactive": { "description": "Disable all interactive prompts", "name": "non-interactive", "allowNo": false, "type": "boolean" }, "dir": { "description": "Working directory", "name": "dir", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "silent": { "description": "This is an internal flag passed by the (no-arg) Import command when it launches a data-source specific import command. The intent is to avoid showing a welcome message twice (if its already been shown by the (no-arg) Import command).", "hidden": true, "name": "silent", "allowNo": false, "type": "boolean" }, "name": { "description": "Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported schema.", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "overwrite": { "dependsOn": [ "name" ], "description": "Overwrite any existing schema with the same name. Cannot be used without also providing a --name flag.", "hidden": true, "name": "overwrite", "allowNo": false, "type": "boolean" }, "db-host": { "description": "Database host and optional port (as HOST[:PORT])", "name": "db-host", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "db-user": { "description": "Database user name", "name": "db-user", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "db-password": { "description": "Database password", "name": "db-password", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "db-database": { "description": "Name of database to import", "name": "db-database", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "db-schema": { "description": "Database schema to import tables from (default: public)", "name": "db-schema", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "db-link-types": { "description": "Automatically link types based on foreign key relationships using @materializer (https://stepzen.com/docs/features/linking-types)", "name": "db-link-types", "allowNo": false, "type": "boolean" }, "db-include": { "description": "Should the generated GraphQL schema be based only on database views, only on tables or on both", "name": "db-include", "hasDynamicHelp": false, "multiple": false, "options": [ "tables-only", "views-only", "tables-and-views" ], "type": "option" }, "db-use-deprecated-2022-naming": { "description": "Use the deprecated pre-2023 naming convention in the generated GraphQL schema:\n\t- the generated type and property names are auto-capitalized into PascalCase\n\t- the generated field names use the getCustomer and getCustomerList style.\n\nOn the other hand, when using the default naming convention:\n\t- the generated type and property names match exactly the DB table and column names\n\t- the generated field names use the customer and customerList style.", "name": "db-use-deprecated-2022-naming", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "import:postgresql", "pluginAlias": "stepzen", "pluginName": "stepzen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "lib", "commands", "import", "postgresql.js" ] }, "import:presto": { "aliases": [], "args": { "dsn": { "description": "(optional) Data Source Name (DSN) of a Presto data source.\nExample: presto://user:password@host:port/catalog\n\nFlags, such as --db-host, override the corresponding parts of the DSN (if both are provided).", "name": "dsn" } }, "description": "Import a schema for a Presto data source into your GraphQL API.\n\nstepzen import presto automatically introspects a Presto database, generates a GraphQL schema for accessing this database through a StepZen API, and merges the generated types, queries and mutations into your into your GraphQL schema.", "flags": { "help": { "char": "h", "description": "Show CLI help", "name": "help", "allowNo": false, "type": "boolean" }, "non-interactive": { "description": "Disable all interactive prompts", "name": "non-interactive", "allowNo": false, "type": "boolean" }, "dir": { "description": "Working directory", "name": "dir", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "silent": { "description": "This is an internal flag passed by the (no-arg) Import command when it launches a data-source specific import command. The intent is to avoid showing a welcome message twice (if its already been shown by the (no-arg) Import command).", "hidden": true, "name": "silent", "allowNo": false, "type": "boolean" }, "name": { "description": "Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported schema.", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "overwrite": { "dependsOn": [ "name" ], "description": "Overwrite any existing schema with the same name. Cannot be used without also providing a --name flag.", "hidden": true, "name": "overwrite", "allowNo": false, "type": "boolean" }, "db-host": { "description": "Database host and optional port (as HOST[:PORT])", "name": "db-host", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "db-user": { "description": "Database user name", "name": "db-user", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "db-password": { "description": "Database password", "name": "db-password", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "db-catalog": { "description": "Name of the catalog to import", "name": "db-catalog", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "db-schema": { "description": "Database schema to import tables from (default: public)", "name": "db-schema", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "db-link-types": { "description": "Automatically link types based on foreign key relationships using @materializer (https://stepzen.com/docs/features/linking-types)", "name": "db-link-types", "allowNo": false, "type": "boolean" }, "db-include": { "description": "Should the generated GraphQL schema be based only on database views, only on tables or on both", "name": "db-include", "hasDynamicHelp": false, "multiple": false, "options": [ "tables-only", "views-only", "tables-and-views" ], "type": "option" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "import:presto", "pluginAlias": "stepzen", "pluginName": "stepzen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "lib", "commands", "import", "presto.js" ] }, "import:snowflake": { "aliases": [], "args": { "dsn": { "description": "(optional) Data Source Name (DSN) of a Snowflake database.\nExample: snowflake://user:password@orgname-accountname/database?warehouse=warehouse&schema=schema\n\nFlags, such as --db-host, override the corresponding parts of the DSN (if both are provided).", "name": "dsn" } }, "description": "Import a schema for a Snowflake data source into your GraphQL API.\n\nstepzen import snowflake automatically introspects a Snowflake database, generates a GraphQL schema for accessing this database through a StepZen API, and merges the generated types, queries and mutations into your GraphQL schema.", "flags": { "help": { "char": "h", "description": "Show CLI help", "name": "help", "allowNo": false, "type": "boolean" }, "non-interactive": { "description": "Disable all interactive prompts", "name": "non-interactive", "allowNo": false, "type": "boolean" }, "dir": { "description": "Working directory", "name": "dir", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "silent": { "description": "This is an internal flag passed by the (no-arg) Import command when it launches a data-source specific import command. The intent is to avoid showing a welcome message twice (if its already been shown by the (no-arg) Import command).", "hidden": true, "name": "silent", "allowNo": false, "type": "boolean" }, "name": { "description": "Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported schema.", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "overwrite": { "dependsOn": [ "name" ], "description": "Overwrite any existing schema with the same name. Cannot be used without also providing a --name flag.", "hidden": true, "name": "overwrite", "allowNo": false, "type": "boolean" }, "db-user": { "description": "Database user name", "name": "db-user", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "db-password": { "description": "Database password", "name": "db-password", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "db-database": { "description": "Name of database to import", "name": "db-database", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "db-schema": { "description": "Database schema to import tables from (default: PUBLIC)", "name": "db-schema", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "db-link-types": { "description": "Automatically link types based on foreign key relationships using @materializer (https://stepzen.com/docs/features/linking-types)", "name": "db-link-types", "allowNo": false, "type": "boolean" }, "db-include": { "description": "Should the generated GraphQL schema be based only on database views, only on tables or on both", "name": "db-include", "hasDynamicHelp": false, "multiple": false, "options": [ "tables-only", "views-only", "tables-and-views" ], "type": "option" }, "db-use-deprecated-2022-naming": { "description": "Use the deprecated pre-2023 naming convention in the generated GraphQL schema:\n\t- the generated type and property names are auto-capitalized into PascalCase\n\t- the generated field names use the getCustomer and getCustomerList style.\n\nOn the other hand, when using the default naming convention:\n\t- the generated type and property names match exactly the DB table and column names\n\t- the generated field names use the customer and customerList style.", "name": "db-use-deprecated-2022-naming", "allowNo": false, "type": "boolean" }, "snowflake-account-id": { "description": "Snowflake account identifier in the orgname-accountname format. For more information, see the Snowflake documentation at https://docs.snowflake.com/en/user-guide/admin-account-identifier.html.", "name": "snowflake-account-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "snowflake-warehouse": { "description": "Snowflake warehouse", "name": "snowflake-warehouse", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "import:snowflake", "pluginAlias": "stepzen", "pluginName": "stepzen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "lib", "commands", "import", "snowflake.js" ] } }, "version": "0.59.0" }