Skip to content

Commit

Permalink
Merge pull request #294 from arikgrahl/improve-installation-documenta…
Browse files Browse the repository at this point in the history
…tion

improve installation documentation
  • Loading branch information
cube2222 authored Sep 19, 2022
2 parents d66b3b2 + bc562e7 commit b62a66a
Showing 1 changed file with 38 additions and 3 deletions.
41 changes: 38 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,15 +62,50 @@ octosql "SELECT * FROM docs.functions fs"

## Installation

### Homebrew

You can install OctoSQL using Homebrew on MacOS or Linux:
```bash
brew install cube2222/octosql/octosql
```
After running it for the first time on MacOS you'll have to go into Preferences -> Security and Privacy -> Allow OctoSQL, as with any app that's not notarized.

You can also download the binary for your operating system directly from the [Releases page](https://github.com/cube2222/octosql/releases), or install using the go command line tool:
```bash
go install -u github.com/cube2222/octosql
### Pre-Compiled binary

You can also download the binary for your operating system directly from the [Releases page](https://github.com/cube2222/octosql/releases).

### Nix Package

The package can be installed in the local nix-profile.

```shell
nix-env -iA nixpkgs.octosql
```

For adhoc or testing purposes a shell with the package can be spawned.

```shell
nix-shell -p octosql
```

For NixOS users it is highly recommended to install the package by adding it to the list of `systemPackages`.

```nix
environment.systemPackages = with pkgs; [
octosql
# ...
];
```

### Building from source

With Go in version >= 1.18 the application can be built from source.
This can be achieved by cloning the repository and running `go install` from the project directory.

```shell
git clone https://github.com/cube2222/octosql
cd octosql
go install
```

## File Access
Expand Down

0 comments on commit b62a66a

Please sign in to comment.