Skip to content

fix: cli package references #386

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Oct 31, 2024
Merged

fix: cli package references #386

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 2 additions & 3 deletions src/content/docs/en/sdk/guides/aws-deployment.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,17 +49,16 @@ Ensure you have the following tools installed on your local machine:
- [Docker](https://docs.docker.com/get-docker/)
- [Node.js](https://nodejs.org/en/download/) ≥ 18
- [jq](https://jqlang.github.io/jq/download/)
- [scroll-sdk-cli](https://www.npmjs.com/package/scroll-sdk-cli)
- [scroll-sdk-cli](https://www.npmjs.com/package/@scroll-tech/scroll-sdk-cli)
- [k9s](https://k9scli.io/topics/install/) (optional, but recommended for cluster management)

{/* TODO: Replace with new cli url */}

Make sure to follow the installation instructions for each tool on their respective websites. For `kubectl`, you can refer to the detailed installation steps provided in the [Amazon EKS documentation](https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html).

To install the scroll-sdk-cli, run:

```bash
npm install -g scroll-sdk-cli
npm install -g @scroll-tech/scroll-sdk-cli
```

{/* TODO: Replace with new command */}
Expand Down
6 changes: 2 additions & 4 deletions src/content/docs/en/sdk/guides/devnet-deployment.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ As we migrate to the Blockscout upgrade with native Scroll SDK support, we haven
- `brew install nvm`
- `nvm install node`
- scroll-sdk-cli *(Experimental, APIs may change)*
- `npm install -g scroll-sdk-cli`
- `npm install -g @scroll-tech/scroll-sdk-cli`
3. You should now be able to open a terminal and run the following:
- `docker -v`
- `kubectl version`
Expand All @@ -74,8 +74,6 @@ As we migrate to the Blockscout upgrade with native Scroll SDK support, we haven
- `scrollsdk`
- Or, in one step: `scrollsdk test dependencies --dev`

{/* TODO: Update the cli command to use the new `scrollsdk` install command */}

</Steps>
</Fragment>
<Fragment slot="panel.2">
Expand Down Expand Up @@ -127,7 +125,7 @@ As we migrate to the Blockscout upgrade with native Scroll SDK support, we haven
curl -o- https://github.com/raw/nvm-sh/nvm/v0.40.1/install.sh | bash
# Re-login or source your shell configuration
nvm install 20
npm install -g scroll-sdk-cli
npm install -g @scroll-tech/scroll-sdk-cli
```
{/* TODO: Update the cli command to use the new `scrollsdk` install command */}

Expand Down
5 changes: 2 additions & 3 deletions src/content/docs/en/sdk/guides/digital-ocean-alt-gas-token.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,12 @@ Please be aware that Blockscout will take a few extra steps to setup without aut
- helm
- docker
- node ≥ 18
- [scroll-sdk-cli](https://www.npmjs.com/package/scroll-sdk-cli) *(see below)*
- [scroll-sdk-cli](https://www.npmjs.com/package/@scroll-tech/scroll-sdk-cli) *(see below)*
- doctl *(optional)*
- k9s *(optional)*

{/* TODO: Update URL to use new package name and command below */}

To install the scroll-sdk-cli, run `npm install -g scroll-sdk-cli`
To install the scroll-sdk-cli, run `npm install -g @scroll-tech/scroll-sdk-cli`

Then, run `scrollsdk test dependencies` to test that the tool works and to check the required dependencies listed above.

Expand Down
3 changes: 1 addition & 2 deletions src/content/docs/en/sdk/technical-stack/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ excerpt: "Information on configuring and customizing a Scroll SDK deployment."

import Aside from "../../../../../components/Aside.astro"

Initial change configuration is made by modifying `config.toml`. All other config files are auto-generated from this file. For automating changes to your configuration for production deployments, see the [scroll-sdk-cli](/en/sdk/technical-stack/scroll-sdk-cli) tool.
{/* TODO: Fix CLI URL to point to github repo */}
Initial change configuration is made by modifying `config.toml`. All other config files are auto-generated from this file. For automating changes to your configuration for production deployments, see the [scroll-sdk-cli](https://www.npmjs.com/package/@scroll-tech/scroll-sdk-cli) tool.

For new production deployments, we recommend using the [example template](https://github.com/scroll-tech/scroll-sdk/blob/develop/examples/config.toml.example), which the `scroll-sdk-cli` tool is designed to work with. You can reference the default devnet configuration [here](https://github.com/scroll-tech/scroll-sdk/blob/develop/charts/scroll-sdk/config.toml).

Expand Down