-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add cli installation instructions (#77)
- Loading branch information
1 parent
2599ed9
commit 67dfa26
Showing
6 changed files
with
193 additions
and
81 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
You can choose to install `meroctl` using either the installation script or | ||
Homebrew. | ||
|
||
import Tabs from '@theme/Tabs'; | ||
import TabItem from '@theme/TabItem'; | ||
|
||
<Tabs | ||
defaultValue="homebrew" | ||
values={[ | ||
{label: 'Homebrew', value: 'homebrew'}, | ||
{label: 'Installation Script', value: 'script'}, | ||
]}> | ||
|
||
<TabItem value="homebrew"> | ||
If you use Homebrew, you can install `meroctl` directly with the following | ||
steps: | ||
|
||
#### Steps | ||
|
||
1. Add the Calimero Homebrew tap: | ||
|
||
```bash | ||
brew tap calimero-network/homebrew-tap | ||
``` | ||
|
||
2. Install `merod`: | ||
|
||
```bash | ||
brew install meroctl | ||
``` | ||
|
||
3. Verify the installation: | ||
```bash | ||
meroctl --version | ||
``` | ||
|
||
If the version number appears, the installation was successful. | ||
|
||
</TabItem> | ||
<TabItem value="script"> | ||
The installation script supports multiple terminal environments and will | ||
automatically configure your PATH based on your shell. | ||
|
||
#### Steps | ||
|
||
1. Open your terminal and run: | ||
|
||
```bash | ||
curl -sSf https://raw.githubusercontent.com/calimero-network/core/master/scripts/install-meroctl.sh | bash | ||
``` | ||
|
||
2. Source the updated PATH: | ||
|
||
```bash | ||
source <your-shell-config-file> | ||
``` | ||
|
||
Replace `<your-shell-config-file>` with `.bashrc`, `.zshrc`, or the relevant | ||
configuration file for your shell. | ||
|
||
3. Verify the installation: | ||
```bash | ||
meroctl --version | ||
``` | ||
|
||
If the version number appears, the installation was successful. | ||
|
||
#### Notes for Shell Environments | ||
|
||
The script automatically updates your PATH based on your shell configuration: | ||
|
||
- **Bash**: Updates `.bashrc`. | ||
- **Zsh**: Updates `.zshrc`. | ||
- **Fish**: Modifies `~/.config/fish/config.fish`. | ||
- **Csh/Tcsh**: Updates `.cshrc`. | ||
|
||
To apply the changes immediately, use the `source` command as described in step | ||
2 above. | ||
|
||
</TabItem> | ||
</Tabs> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
You can choose to install `merod` using either the installation script or | ||
Homebrew. | ||
|
||
import Tabs from '@theme/Tabs'; | ||
import TabItem from '@theme/TabItem'; | ||
|
||
<Tabs | ||
defaultValue="homebrew" | ||
values={[ | ||
{label: 'Homebrew', value: 'homebrew'}, | ||
{label: 'Installation Script', value: 'script'}, | ||
]}> | ||
|
||
<TabItem value="homebrew"> | ||
If you use Homebrew, you can install `merod` directly with the following | ||
steps: | ||
|
||
#### Steps | ||
|
||
1. Add the Calimero Homebrew tap: | ||
|
||
```bash | ||
brew tap calimero-network/homebrew-tap | ||
``` | ||
|
||
2. Install `merod`: | ||
|
||
```bash | ||
brew install merod | ||
``` | ||
|
||
3. Verify the installation: | ||
```bash | ||
merod --version | ||
``` | ||
|
||
If the version number appears, the installation was successful. | ||
|
||
</TabItem> | ||
<TabItem value="script"> | ||
The installation script supports multiple terminal environments and will | ||
automatically configure your PATH based on your shell. | ||
|
||
#### Steps | ||
|
||
1. Open your terminal and run: | ||
|
||
```bash | ||
curl -sSf https://raw.githubusercontent.com/calimero-network/core/master/scripts/install-merod.sh | bash | ||
``` | ||
|
||
2. Source the updated PATH: | ||
|
||
```bash | ||
source <your-shell-config-file> | ||
``` | ||
|
||
Replace `<your-shell-config-file>` with `.bashrc`, `.zshrc`, or the relevant | ||
configuration file for your shell. | ||
|
||
3. Verify the installation: | ||
```bash | ||
merod --version | ||
``` | ||
|
||
If the version number appears, the installation was successful. | ||
|
||
#### Notes for Shell Environments | ||
|
||
The script automatically updates your PATH based on your shell configuration: | ||
|
||
- **Bash**: Updates `.bashrc`. | ||
- **Zsh**: Updates `.zshrc`. | ||
- **Fish**: Modifies `~/.config/fish/config.fish`. | ||
- **Csh/Tcsh**: Updates `.cshrc`. | ||
|
||
To apply the changes immediately, use the `source` command as described in step | ||
2 above. | ||
|
||
</TabItem> | ||
</Tabs> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters