Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: @opensdks/cli for simplified SDK Generation #1

Open
xdotli opened this issue Dec 5, 2023 · 1 comment
Open

feat: @opensdks/cli for simplified SDK Generation #1

xdotli opened this issue Dec 5, 2023 · 1 comment
Assignees
Labels

Comments

@xdotli
Copy link
Collaborator

xdotli commented Dec 5, 2023

Description:
We are planning to develop a new CLI tool, tentatively named @opensdks/cli, to streamline the process of generating SDKs from OpenAPI specifications. This tool will be an npm package and can be invoked using npx opensdks gen .... The idea is to follow the usability patterns of similar tools like openapi-typescript cli and create-next-app@latest.

Key Features and Workflow:

  1. Input and Output:

    • The CLI will accept the URL of an OpenAPI specification as input.
    • The output will be a complete package that users can submit as a PR to our repository or use locally.
  2. User Interaction:

    • The tool will provide an interactive interface - similar to npx create-next-app@latest, where users can input information as required during the generation process.
    • Alternatively, users can pass options directly in the CLI command for a non-interactive experience.
  3. Ease of Use:

    • The aim is to make the SDK generation process as simple as possible, ideally boiling it down to a one-liner command.
    • Example usage: npx @opensdks/cli $OPENAPI_URL sdk-custom.
@xdotli xdotli added the feature label Dec 5, 2023
@xdotli xdotli self-assigned this Dec 5, 2023
@tonyxiao
Copy link
Owner

Merging other tasks in here

  • [Tools] Cli building on top of openapi-typescript to add additional functionality (extract server constant, export *, etc.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants