-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(README,CONTRIBUTING): update to latest version (#194)
Because - the documentation has been out-dated This commit - make the content up-to-date
- Loading branch information
Showing
2 changed files
with
102 additions
and
49 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| # Contributing Guidelines | ||
|
|
||
| We appreciate your contribution to this amazing project! Any form of engagement is welcome, including but not limiting to | ||
|
|
||
| - feature request | ||
| - documentation wording | ||
| - bug report | ||
| - roadmap suggestion | ||
| - ...and so on! | ||
|
|
||
| Please refer to the [community contributing section](https://github.com/instill-ai/community#contributing) for more details. | ||
|
|
||
| ## Development and codebase contribution | ||
|
|
||
| Before delving into the details to come up with your first PR, please familiarise yourself with the project structure of [Instill Core](https://github.com/instill-ai/community#instill-core). | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| - Make | ||
| - Go >= 1.18 | ||
|
|
||
| ### Build and install local binary | ||
|
|
||
| ```shell | ||
| $ make install | ||
| ``` | ||
|
|
||
| ### Uninstall local binary | ||
|
|
||
| ```shell | ||
| $ make uninstall | ||
| ``` | ||
|
|
||
| #### Run unit tests | ||
|
|
||
| ```shell | ||
| $ make test | ||
| ``` | ||
|
|
||
| ### Sending PRs | ||
|
|
||
| Please take these general guidelines into consideration when you are sending a PR: | ||
|
|
||
| 1. **Fork the Repository:** Begin by forking the repository to your GitHub account. | ||
| 2. **Create a New Branch:** Create a new branch to house your work. Use a clear and descriptive name, like `<your-github-username>/<what-your-pr-about>`. | ||
| 3. **Make and Commit Changes:** Implement your changes and commit them. We encourage you to follow these best practices for commits to ensure an efficient review process: | ||
| - Adhere to the [conventional commits guidelines](https://www.conventionalcommits.org/) for meaningful commit messages. | ||
| - Follow the [7 rules of commit messages](https://chris.beams.io/posts/git-commit/) for well-structured and informative commits. | ||
| - Rearrange commits to squash trivial changes together, if possible. Utilize [git rebase](http://gitready.com/advanced/2009/03/20/reorder-commits-with-rebase.html) for this purpose. | ||
| 4. **Push to Your Branch:** Push your branch to your GitHub repository: `git push origin feat/<your-feature-name>`. | ||
| 5. **Open a Pull Request:** Initiate a pull request to our repository. Our team will review your changes and collaborate with you on any necessary refinements. | ||
|
|
||
| When you are ready to send a PR, we recommend you to first open a `draft` one. This will trigger a bunch of `integration-test` [workflows](https://github.com/instill-ai/model/tree/main/.github/workflows) running a thorough test suite on multiple platforms. After the tests are done and passed, you can now mark the PR `open` to notify the codebase owners to review. We appreciate your endeavour to pass the integration test for your PR to make sure the sanity with respect to the entire scope of **Instill Core**. | ||
|
|
||
| ## Last words | ||
|
|
||
| Your contributions make a difference. Let's build something amazing together! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,82 +1,78 @@ | ||
| <h1 align="center"> | ||
| <img src="https://raw.githubusercontent.com/instill-ai/.github/main/img/cli.png" alt="Instill AI - Unstructured Data ETL Made for All" /> | ||
| </h1> | ||
|
|
||
| <h4 align="center"> | ||
| <a href="https://www.instill.tech/?utm_source=github&utm_medium=banner&utm_campaign=cli_readme">Website</a> | | ||
| <a href="https://discord.gg/sevxWsqpGh">Community</a> | | ||
| <a href="https://blog.instill.tech/?utm_source=github&utm_medium=banner&utm_campaign=cli_readme">Blog</a><br/><br/> | ||
| <a href="https://www.instill.tech/docs/?utm_source=github&utm_medium=banner&utm_campaign=cli_readme">User Manual</a> | | ||
| <a href="https://discord.gg/sevxWsqpGh">API Reference</a><br/><br/> | ||
| <a href="https://www.instill.tech/get-access/?utm_source=github&utm_medium=banner&utm_campaign=cli_readme"><strong>Get Early Access</strong></a> | ||
| </h4> | ||
|
|
||
| --- | ||
| # Instill CLI | ||
|
|
||
| [](https://github.com/instill-ai/cli/actions/workflows/go.yml) | ||
| [](https://github.com/instill-ai/cli/releases/latest) | ||
| [](./License.md) | ||
| [](.github/code_of_conduct.md) | ||
|
|
||
| `inst` is the command line interface for **Instill Core / Cloud**. | ||
|
|
||
| ## Table of contents <!-- omit in toc --> | ||
| - [What is Instill Cloud?](#what-is-instill-cloud) | ||
| - [Installation](#installation) | ||
| - [Usage examples](#usage-examples) | ||
| - [Issues and discussions](#issues-and-discussions) | ||
| 📺 `inst` is a command line tool for **[Instill Core](https://github.com/instill-ai/community#instill-core)/[Cloud](https://github.com/instill-ai/community#instill-cloud)**. | ||
|
|
||
| ## What is Instill Cloud? | ||
| ☁️ **Instill Cloud** offers fully managed **Instill Core**. Please [sign up](https://console.instill.tech) to try out for free. | ||
|
|
||
| Instill AI is on a mission to make AI accessible to everyone. With **Instill Cloud**, one can easily build up a data pipeline to transform unstructured data to meaningful data representations, starting to tap on the value of unstructured data. | ||
| ## Prerequisites | ||
|
|
||
| **Instill Cloud** provides a **Pipeline** consisting of **Source Connector**, **Model**, **Logic Operator** and **Destination Connector** components, to process unstructured data to their meaningful data representations. | ||
| - **macOS or Linux** - `inst` works on macOS or Linux, but does not support Windows yet. | ||
|
|
||
| ## Installation | ||
|
|
||
| ### macOS <!-- omit in toc --> | ||
|
|
||
| `instill` is available via [Homebrew][] and as a downloadable binary from the [releases page][]. | ||
| ## Installation | ||
|
|
||
| #### Homebrew <!-- omit in toc --> | ||
| `inst` is available via [Homebrew](https://brew.sh) and as a downloadable binary from the [releases page][]. | ||
|
|
||
| To install: | ||
| ``` | ||
| brew install instill-ai/tap/inst | ||
| $ brew install instill-ai/tap/inst | ||
| ``` | ||
|
|
||
| To uninstall: | ||
| ``` | ||
| $ brew uninstall inst | ||
| ``` | ||
|
|
||
| To upgrade: | ||
| ``` | ||
| brew upgrade instill-ai/tap/inst | ||
| $ brew upgrade inst | ||
| ``` | ||
|
|
||
| ## Usage examples | ||
|
|
||
| ```bash | ||
| # log in | ||
|
|
||
| # Check all available commands | ||
| $ inst help | ||
|
|
||
| # Deploy a local Instill Core | ||
| $ inst local deploy | ||
|
|
||
| # Undeploy a local Instill Core | ||
| $ inst local undeploy | ||
|
|
||
| # Authorisation for an instance (default to Instill Cloud https://api.instill.tech) | ||
| $ inst auth login | ||
|
|
||
| # list pipelines | ||
| $ inst api pipelines | ||
| # REST API request | ||
| $ inst api vdp/alpha1/pipelines | ||
| ``` | ||
|
|
||
| # list models | ||
| $ inst api model/models | ||
| ## Documentation | ||
|
|
||
| # add parameters to a GET request | ||
| $ inst api model/models?visibility=public | ||
| 📔 **Documentation** | ||
|
|
||
| # list instances | ||
| $ inst instances list | ||
| Please check out the [documentation](https://www.instill.tech/docs?utm_source=github&utm_medium=banner&utm_campaign=vdp_readme) website. | ||
|
|
||
| # add nested JSON body to a POST request | ||
| $ jq -n '{"contents":[{"url": "https://artifacts.instill.tech/dog.jpg"}]}' | inst api demo/tasks/classification/outputs --input - | ||
| 📘 **API Reference** | ||
|
|
||
| # set a custom HTTP header | ||
| $ inst api -H 'Authorization: Basic mytoken' ... | ||
| ``` | ||
| The gRPC protocols in [protobufs](https://github.com/instill-ai/protobufs) provide the single source of truth for the VDP APIs. The genuine protobuf documentation can be found in our [Buf Scheme Registry (BSR)](https://buf.build/instill-ai/protobufs). | ||
|
|
||
| For the OpenAPI documentation, access http://localhost:3001 after `make all`, or simply run `make doc`. | ||
|
|
||
| ## Contributing | ||
|
|
||
| Please refer to the [Contributing Guidelines](./.github/CONTRIBUTING.md) for more details. | ||
|
|
||
| ## Community support | ||
|
|
||
| Please refer to the [community](https://github.com/instill-ai/community) repository. | ||
|
|
||
| ## Issues and discussions | ||
| Please directly report any issues in [Issues](https://github.com/instill-ai/cli/issues) or [Pull requests](https://github.com/instill-ai/cli/pulls), or raise a topic in [Discussions](https://github.com/instill-ai/cli/discussions). | ||
| ## License | ||
|
|
||
| [Homebrew]: https://brew.sh | ||
| [releases page]: https://github.com/instill-ai/cli/releases/latest | ||
| See the [LICENSE](./LICENSE) file for licensing information. |