Skip to content

Commit

Permalink
Update CLI Docs (#57)
Browse files Browse the repository at this point in the history
## Description
Update the cli tutorial sections for the go cli.
Bring those same sections up to date for use with Dusk-5

---------

Co-authored-by: quasystaty <[email protected]>
  • Loading branch information
sambukowski and quasystaty1 authored May 25, 2024
1 parent fbb72c0 commit fa51e43
Show file tree
Hide file tree
Showing 20 changed files with 1,001 additions and 243 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,28 +5,27 @@ The Astria Docs website built with [VitePress](https://vitepress.dev/)
### Installation

To get started, clone the repository and run the following:

```
npm add -D vitepress
```

### Local Development

To run a local development site:

```
npm run docs:dev
```

This command starts a local development server. Most changes are reflected live without having to restart the server.


### Build


```
npm run docs:build
```


This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment
Expand Down
28 changes: 26 additions & 2 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,32 @@ function sidebar() {
{ text: 'Digital Ocean', link: '/cloud-rollup/digital-ocean' },
]
},
{ text: 'Using the astria cli', link: '/developer/tutorials/1-using-astria-go-cli.md' },

{
text: 'Using the Astria cli',
collapsed: true,
items: [
{text: 'Install the CLI', link: '/developer/tutorials/install-the-cli.md'},
{text: 'Run a Local Rollup and Sequencer', link: '/developer/tutorials/run-local-rollup-and-sequencer.md' },
{text: 'Run a Local Rollup against a Remote Sequencer', link: '/developer/tutorials/run-local-rollup-against-remote-sequencer.md' },
{text: 'Test Transactions', link: '/developer/tutorials/test-transactions.md' },
]
}
]
},
{
text: 'References',
collapsed: true,
items: [
{text: 'Astria Endpoints', link: '/developer/references/endpoints.md'},
{
text: 'astria-go cli',
collapsed: true,
items: [
{text: 'Installation', link: '/developer/references/astria-go/cli-installation.md'},
{text: 'Commands', link: '/developer/references/astria-go/cli-commands.md'},
{text: 'Networks Configuration', link: '/developer/references/astria-go/cli-networks-configuration.md'},
]
}
]
},
{
Expand Down
32 changes: 32 additions & 0 deletions docs/components/_astria-go-cli-install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@

::: code-group

```bash [ARM Mac]
curl -L https://github.com/astriaorg/astria-cli-go/releases/download/v0.7.1/astria-go-v0.7.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.7.1/astria-go-v0.7.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.7.1/astria-go-v0.7.1-linux-amd64.tar.gz > astria-cli.tar.gz
tar -xvzf astria-cli.tar.gz
mv astria-go /usr/local/bin/
astria-go version
```

:::

<!-- <Tabs>
<TabItem value="ARM Mac" label="ARM Mac" default> </TabItem>
<TabItem value="X86_64 Mac" label="X86_64 Mac"> </TabItem>
<TabItem value="x86_64 Linux" label="x86_64 Linux"> </TabItem>

</Tabs> -->
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/components/_cli-cloud.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!--@include: ./_astria-cli-install.md-->
<!--@include: ./_astria-rust-cli-install.md-->

- kubectl - [https://kubernetes.io/docs/tasks/tools/](https://kubernetes.io/docs/tasks/tools/)
- helm - [https://helm.sh/docs/intro/install/](https://helm.sh/docs/intro/install/)
2 changes: 1 addition & 1 deletion docs/components/_cli-local.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!--@include: ./_astria-cli-install.md-->
<!--@include: ./_astria-rust-cli-install.md-->

- docker - [https://docs.docker.com/get-docker/](https://docs.docker.com/get-docker/)
- kubectl - [https://kubernetes.io/docs/tasks/tools/](https://kubernetes.io/docs/tasks/tools/)
Expand Down
Loading

0 comments on commit fa51e43

Please sign in to comment.