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.

Sign up for GitHub

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

docs: Add environment section to CLI docs #160

Merged
merged 1 commit into from
Nov 28, 2024
Merged

docs: Add environment section to CLI docs #160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,13 @@ npx @inferable/cli <cmd>
To authenticate the CLI, run `inf auth login`.
This will open a browser and prompt you to login to the Inferable console.

### Environment

The CLI respects use the following environment variables if available:

- `INFERABLE_API_ENDPOINT`: The Inferable API endpoint to use (See [self-hosting guide](https://docs.inferable.ai/pages/self-hosting)).
- `INFERABLE_CLUSTER_ID`: Cluster related commands will automatically use this cluster.

### Commands

- **inf clusters**: Manage Inferable clusters.
Expand Down
2 changes: 1 addition & 1 deletion cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ commit_preprocessors = [
commit_parsers = [
{ message = "^feat", group = "<!-- 0 -->⛰️ Features" },
{ message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
{ message = "^doc", group = "<!-- 3 -->📚 Documentation" },
{ message = "^docs", group = "<!-- 3 -->📚 Documentation" },
{ message = "^perf", group = "<!-- 4 -->⚡ Performance" },
{ message = "^refactor\\(clippy\\)", skip = true },
{ message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },
Expand Down