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

basic docs for cli binaries #371

Merged
merged 5 commits into from
Jul 29, 2024
Merged
Changes from 4 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
33 changes: 33 additions & 0 deletions 020-Connect/015-CLI/010-cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,39 @@ Xata provides a CLI (command line interface) through an **[NPM package](https://

## Installation

### Macos
eemmiillyy marked this conversation as resolved.
Show resolved Hide resolved

- Install Homebrew then run:
eemmiillyy marked this conversation as resolved.
Show resolved Hide resolved

```bash
brew tap xataio/brew && brew install xata
```

### Windows
eemmiillyy marked this conversation as resolved.
Show resolved Hide resolved

- [64-bit installer](https://xata-cli-assets.s3.us-east-1.amazonaws.com/channels/stable/xata-x64.exe)
- [32-bit installer](https://xata-cli-assets.s3.us-east-1.amazonaws.com/channels/stable/xata-x86.exe)

### Standalone Tarball containing Binary
eemmiillyy marked this conversation as resolved.
Show resolved Hide resolved

- We provide binaries in .gz and .xz formats.

eemmiillyy marked this conversation as resolved.
Show resolved Hide resolved
- We provide a setup script for Linux users who do not wish to extract the tarball themselves:

```bash
curl xata.io/install.sh | sh
```

- [macOS (m1)](https://xata-cli-assets.s3.us-east-1.amazonaws.com/channels/stable/xata-darwin-arm64.tar.gz)
- [macOS (Intel)](https://xata-cli-assets.s3.us-east-1.amazonaws.com/channels/stable/xata-darwin-x64.tar.gz)
- [Linux (x64)](https://xata-cli-assets.s3.us-east-1.amazonaws.com/channels/stable/xata-linux-x64.tar.gz)
- [Linux (arm)](https://xata-cli-assets.s3.us-east-1.amazonaws.com/channels/stable/xata-linux-arm.tar.gz)
- [Linux (arm64)](https://xata-cli-assets.s3.us-east-1.amazonaws.com/channels/stable/xata-linux-arm64.tar.gz)
eemmiillyy marked this conversation as resolved.
Show resolved Hide resolved
- [Windows (x64)](https://xata-cli-assets.s3.us-east-1.amazonaws.com/channels/stable/xata-win32-x64.tar.gz)
- [Windows (x86)](https://xata-cli-assets.s3.us-east-1.amazonaws.com/channels/stable/xata-win32-x86.tar.gz)
eemmiillyy marked this conversation as resolved.
Show resolved Hide resolved

### Install with npm

To facilitate work across multiple projects and reduce the number of parameters required for executing commands, we advise installing the CLI globally.

```bash
Expand Down
Loading