Skip to content

Commit

Permalink
Refactor: Source download sections for cli and geth (#69)
Browse files Browse the repository at this point in the history
Created new docs components for downloading from source for different
components.

closes #68
  • Loading branch information
sambukowski authored Aug 20, 2024
1 parent ea54e68 commit 5e2d9b7
Show file tree
Hide file tree
Showing 8 changed files with 73 additions and 26 deletions.
28 changes: 23 additions & 5 deletions docs/components/_astria-go-cli-build-from-source.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
This requires `Go` and `just` to be installed on your system.

- Go: <https://go.dev/doc/install>
- just: <https://github.com/casey/just>
::: code-group

```bash
```bash [SSH]
git clone [email protected]:astriaorg/astria-cli-go.git
cd astria-cli-go
just build-cli
just build

# run the cli in the repo directory
just run version
Expand All @@ -15,3 +13,23 @@ just run version
mv ./bin/astria-go /usr/local/bin/
astria-go version
```

```bash [HTTPS]
git clone https://github.com/astriaorg/astria-cli-go.git
cd astria-cli-go
just build

# run the cli in the repo directory
just run version

# OR you can move the binary to a location in your PATH if you'd like
mv ./bin/astria-go /usr/local/bin/
astria-go version
```

:::

<!-- <Tabs>
<TabItem value="SSH" label="SSH"> </TabItem>
<TabItem value="HTTPS" label="HTTPS" default> </TabItem>
</Tabs> -->
6 changes: 3 additions & 3 deletions docs/components/_astria-go-cli-install.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
::: code-group

```bash [ARM Mac]
curl -L https://github.com/astriaorg/astria-cli-go/releases/download/v0.11.0/astria-go-v0.9.0-darwin-arm64.tar.gz > astria-cli.tar.gz
curl -L https://github.com/astriaorg/astria-cli-go/releases/download/v0.13.1/astria-go-v0.13.1-darwin-arm64.tar.gz > astria-cli.tar.gz
tar -xvzf astria-cli.tar.gz
mv astria-go /usr/local/bin/
astria-go version
```

```bash [X86_64 Mac]
curl -L https://github.com/astriaorg/astria-cli-go/releases/download/v0.11.0/astria-go-v0.9.0-darwin-amd64.tar.gz > astria-cli.tar.gz
curl -L https://github.com/astriaorg/astria-cli-go/releases/download/v0.13.1/astria-go-v0.13.1-darwin-amd64.tar.gz > astria-cli.tar.gz
tar -xvzf astria-cli.tar.gz
mv astria-go /usr/local/bin/
astria-go version
```

```bash [x86_64 Linux]
curl -L https://github.com/astriaorg/astria-cli-go/releases/download/v0.11.0/astria-go-v0.9.0-linux-amd64.tar.gz > astria-cli.tar.gz
curl -L https://github.com/astriaorg/astria-cli-go/releases/download/v0.13.1/astria-go-v0.13.1-linux-amd64.tar.gz > astria-cli.tar.gz
tar -xvzf astria-cli.tar.gz
mv astria-go /usr/local/bin/
astria-go version
Expand Down
23 changes: 23 additions & 0 deletions docs/components/_clone-geth.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@

::: code-group

```bash [SSH]
git clone [email protected]:astriaorg/astria-geth.git
cd astria-geth
git checkout local-dev
just build
```

```bash [HTTPS]
git clone https://github.com/astriaorg/astria-geth.git
cd astria-geth
git checkout local-dev
just build
```

:::

<!-- <Tabs>
<TabItem value="SSH" label="SSH"> </TabItem>
<TabItem value="HTTPS" label="HTTPS" default> </TabItem>
</Tabs> -->
5 changes: 5 additions & 0 deletions docs/developer/references/astria-go/cli-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,9 @@ View all releases [here](https://github.com/astriaorg/astria-cli-go/releases).

## Build from Source

This requires `Go` and `just` to be installed on your system.

- Go: <https://go.dev/doc/install>
- just: <https://github.com/casey/just>

<!--@include: ../../../components/_astria-go-cli-build-from-source.md-->
5 changes: 5 additions & 0 deletions docs/developer/tutorials/install-the-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ View all releases [here](https://github.com/astriaorg/astria-cli-go/releases).

## Build from Source

This requires `Go` and `just` to be installed on your system.

- [Go](https://go.dev/doc/install)
- [just](https://github.com/casey/just)

<!--@include: ../../components/_astria-go-cli-build-from-source.md-->

## Commands Used in this Tutorial
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,13 @@ Astria stack locally on your machine.

Requires `Go`, `just`, and `Foundry`:

- Go: <https://go.dev/doc/install>
- just: <https://github.com/casey/just>
- Foundry: <https://book.getfoundry.sh/getting-started/installation>
- [Go](https://go.dev/doc/install)
- [just](https://github.com/casey/just)
- [Foundry](https://book.getfoundry.sh/getting-started/installation)

Open a new terminal window and clone and build Geth.

```bash
git clone [email protected]:astriaorg/astria-geth.git
cd astria-geth
git checkout local-dev
just build
```
<!--@include: ../../components/_clone-geth.md-->

### Configure the Geth Genesis Information

Expand Down
13 changes: 4 additions & 9 deletions docs/developer/tutorials/run-local-rollup-and-sequencer.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,13 @@ Astria stack locally on your machine.

Requires `Go`, `just`, and `Foundry`:

- Go: <https://go.dev/doc/install>
- just: <https://github.com/casey/just>
- Foundry: <https://book.getfoundry.sh/getting-started/installation>
- [Go](https://go.dev/doc/install)
- [just](https://github.com/casey/just)
- [Foundry](https://book.getfoundry.sh/getting-started/installation)

Open a new terminal window and clone and build Geth:

```bash
git clone [email protected]:astriaorg/astria-geth.git
cd astria-geth
git checkout local-dev
just build
```
<!--@include: ../../components/_clone-geth.md-->

Create a new genesis account for your Geth rollup:

Expand Down
6 changes: 6 additions & 0 deletions docs/dusk-faq/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,14 @@ The latest Devnet (dusk-8) runs the following software versions:

## Install the latest Astria cli

Download using curl:

<!--@include: ../components/_astria-go-cli-install.md-->

Build from source:

<!--@include: ../components/_astria-go-cli-build-from-source.md-->

## `astria-go` CLI Commands

[View all the `astria-go` cli commands.](../developer/references/astria-go/cli-commands.md)

0 comments on commit 5e2d9b7

Please sign in to comment.