Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
24 changes: 20 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,19 +36,35 @@ Realtime: Realtime gateway API service

<!-- End Table of Contents [toc] -->

<!-- Start CLI Installation [installation] -->
<!--
This section is intentionally NOT Speakeasy-managed. See the `No ... [tag]` marker
at the end of the section.

Speakeasy hardcodes the install URL branch as `main`: it is not derived from the
repository's default branch, and no gen.yaml/workflow.yaml key overrides it. This
repository's default branch is `master`, so the generated URLs 404. The URLs below
use `HEAD`, which GitHub resolves to whatever the default branch currently is, so a
future branch rename cannot re-break them.

Two consequences of hand-owning this section, both intentional:
- Restoring the `Start`/`End` markers silently reverts these URLs to a 404.
- Speakeasy no longer contributes to this section. If any of the dormant
`cli.distribution` channels in .speakeasy/gen.yaml (homebrew, nfpm, winget) is
enabled later, its install instructions will NOT appear here automatically and
must be added by hand.
-->
## CLI Installation

### Quick Install (Linux/macOS)

```bash
curl -fsSL https://raw.githubusercontent.com/voiceflow/cli/main/scripts/install.sh | bash
curl -fsSL https://raw.githubusercontent.com/voiceflow/cli/HEAD/scripts/install.sh | bash
```

### Quick Install (Windows PowerShell)

```powershell
iwr -useb https://raw.githubusercontent.com/voiceflow/cli/main/scripts/install.ps1 | iex
iwr -useb https://raw.githubusercontent.com/voiceflow/cli/HEAD/scripts/install.ps1 | iex
```

### Go Install
Expand All @@ -62,7 +78,7 @@ go install github.com/voiceflow/cli/cmd/vf@latest
### Manual Download

Download pre-built binaries for your platform from the [releases page](https://github.com/voiceflow/cli/releases).
<!-- End CLI Installation [installation] -->
<!-- No CLI Installation [installation] -->

<!-- Start Shell Completion [completion] -->
## Shell Completion
Expand Down
4 changes: 2 additions & 2 deletions scripts/install.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
# This script downloads and installs the latest version of the vf CLI
#
# Usage:
# iwr -useb https://raw.githubusercontent.com/voiceflow/cli/main/scripts/install.ps1 | iex
# iwr -useb https://raw.githubusercontent.com/voiceflow/cli/HEAD/scripts/install.ps1 | iex
# or
# Invoke-WebRequest -Uri https://raw.githubusercontent.com/voiceflow/cli/main/scripts/install.ps1 -UseBasicParsing | Invoke-Expression
# Invoke-WebRequest -Uri https://raw.githubusercontent.com/voiceflow/cli/HEAD/scripts/install.ps1 -UseBasicParsing | Invoke-Expression
#
# Options:
# $env:VF_INSTALL_DIR - Installation directory (default: $env:LOCALAPPDATA\Programs\vf)
Expand Down
4 changes: 2 additions & 2 deletions scripts/install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
# for Linux and macOS systems.
#
# Usage:
# curl -fsSL https://raw.githubusercontent.com/voiceflow/cli/main/scripts/install.sh | bash
# curl -fsSL https://raw.githubusercontent.com/voiceflow/cli/HEAD/scripts/install.sh | bash
# or
# wget -qO- https://raw.githubusercontent.com/voiceflow/cli/main/scripts/install.sh | bash
# wget -qO- https://raw.githubusercontent.com/voiceflow/cli/HEAD/scripts/install.sh | bash
#
# Options:
# VF_INSTALL_DIR - Installation directory (default: /usr/local/bin)
Expand Down