JSight CLI is the cli tool which performs various task when working with JSight API language.
The JSight CLI allows you to perform the following tasks:
- Parsing code in the JSight API language and checking JSight API syntax.
- Generating HTML API documentation in a single
*.htmlfile. - Converting JSight to OpenAPI 3.0.
🔥 If you have any ideas or suggestions, please share with us:
- Email: [email protected]
- Telegram: @jsight_support
Download jsight cli tool from the official website and move to the /usr/local/bin folder:
wget https://jsight.io/downloads/jsight-cli/1.1.0/linux-x64/jsight
mv jsight /usr/local/bin
chmod +x /usr/local/bin/jsightCheck the installation:
jsight versionDownload jsight cli tool from the official website and move to the /usr/local/bin folder:
wget https://jsight.io/downloads/jsight-cli/1.1.0/macos-x64/jsight && mv jsight /usr/local/bin && chmod +x /usr/local/bin/jsightCheck the installation:
jsight versionDownload jsight.exe cli tool from the official website (Powershell):
curl https://jsight.io/downloads/jsight-cli/1.1.0/windows-x64/jsight.exe -outfile jsight.exeCheck the installation:
jsight.exe versionjsight version— outputs the current version of JSight CLI.jsight help— outputs the manaul fo JSight CLI.jsight doc html <jsight file>— parses the<jsight file>and outputs the corresponding html document (or an error description).jsight convert openapi yaml <jsight file>— parses the<jsight file>, converts it to OpenAPI and outputs the OpenAPI definition in the YAML format.jsight convert openapi json <jsight file>— parses the<jsight file>, converts it to OpenAPI and outputs the OpenAPI definition in the JSON format.
Creating HTML doc example:
jsight doc html my-api-spec.jst > my-api-spec.htmlConverting to OpenAPI example:
jsight convert openapi yaml my-api-spec.jst > my-api-spec.openapimake— builds binary to the./buildfolder and runs the tests.make build— builds binary to the./buildfolder.make test— runs the tests against the./build/jsightbinary.
The JSight CLI adheres to the Semantic Versioning 2.0.0.
{MAJOR version}.{MINOR version}.{PATCH version}
The JSight CLI version is specified in the file
main.go in the global variable Version.
All the dependencies are described in the file go.mod.
Contributing is more than just coding. You can help the project in many ways, and we will be very happy to accept your contribution to our project.
Details of how you can help the project are described in the CONTRIBUTING.md document.
Do you have a bug report or a feature request?
Please feel free to add a new issue or write to us in support:
- Email: [email protected]
- Telegram: @jsight_support
If something is unclear to you, please contact support; we try to respond within 24 hours. Moreover, it is critical for us to understand what is unclear from the first instance.
- Email: [email protected]
- Telegram: @jsight_support
This project is licensed under the Apache 2.0 License. See the LICENSE file for more details.
- JSight Official Website: https://jsight.io.
- JSight API Language Quick Tutorial: https://jsight.io/docs/jsight-api-0-3-quick-tutorial.
- JSight API language specification on the official website: https://jsight.io/docs/jsight-api-0-3.
- JSight API language specification on GitHub: https://github.com/jsightapi/specification/tree/main/versions/JSight%20API.
- JSight blog: https://jsight.io/blog.
- Official Facebook page: https://www.facebook.com/jsightapi.
- Official Twitter: https://twitter.com/jsightapi.
- Official Linkedin: https://www.linkedin.com/company/jsightapi.
- All JSight repositories: https://github.com/jsightapi.
- We have successfully completed class #29 of the Alchemist Accelerator.
We sincerely thank all those without whom this project would not have been possible:
- Alchemist Accelerator,
- Urfave for his cli library,
- Lucas Jones for his reggen library.
⭐ Star us on GitHub — it motivates us a lot! ⭐