diff --git a/docs/02-getting-started/01-setup.mdx b/docs/02-getting-started/01-setup.mdx index 01e173d1..7cddb49b 100644 --- a/docs/02-getting-started/01-setup.mdx +++ b/docs/02-getting-started/01-setup.mdx @@ -3,6 +3,10 @@ id: setup title: Setup --- +import MerodInstallation from '../shared/install-merod.mdx'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + # Setup This guide will help you set up Calimero in your device. @@ -29,87 +33,7 @@ If your platform is not supported, please ### Installation -You can choose to install `merod` using either the installation script or -Homebrew. - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - - - - -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 merod - ``` - -3. Verify the installation: - ```bash - merod --version - ``` - -If the version number appears, the installation was successful. - - - -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 - ``` - - Replace `` 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. - - - + ### Next Steps diff --git a/docs/05-developer-tools/01-CLI/01-merod.mdx b/docs/05-developer-tools/01-CLI/01-merod.mdx index a8ced6fe..8cb3ccdc 100644 --- a/docs/05-developer-tools/01-CLI/01-merod.mdx +++ b/docs/05-developer-tools/01-CLI/01-merod.mdx @@ -3,8 +3,19 @@ id: merod title: Merod --- +import MerodInstallation from '../../shared/install-merod.mdx'; + Merod is a command-line tool that allows you to manage Calimero nodes. +
+ Installation +

+ +

+
+ +## Usage + ```bash title="Terminal" merod [OPTIONS] --node-name ``` diff --git a/docs/05-developer-tools/01-CLI/02-meroctl.mdx b/docs/05-developer-tools/01-CLI/02-meroctl.mdx index 396804b9..ba83211e 100644 --- a/docs/05-developer-tools/01-CLI/02-meroctl.mdx +++ b/docs/05-developer-tools/01-CLI/02-meroctl.mdx @@ -3,8 +3,19 @@ id: meroctl title: Meroctl --- +import MeroctlInstallation from '../../shared/install-meroctl.mdx'; + Meroctl is a command-line tool that enables you to use node functionalities. +
+ Installation +

+ +

+
+ +## Usage + ```bash title="Terminal" meroctl [OPTIONS] --node-name ``` diff --git a/docs/shared/install-meroctl.mdx b/docs/shared/install-meroctl.mdx new file mode 100644 index 00000000..e967e226 --- /dev/null +++ b/docs/shared/install-meroctl.mdx @@ -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'; + + + + +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. + + + +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 + ``` + + Replace `` 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. + + + diff --git a/docs/shared/install-merod.mdx b/docs/shared/install-merod.mdx new file mode 100644 index 00000000..35b04e56 --- /dev/null +++ b/docs/shared/install-merod.mdx @@ -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'; + + + + +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. + + + +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 + ``` + + Replace `` 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. + + + diff --git a/i18n/en/docusaurus-plugin-content-docs/current.json b/i18n/en/docusaurus-plugin-content-docs/current.json index a3420d6a..3d5bc63f 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current.json +++ b/i18n/en/docusaurus-plugin-content-docs/current.json @@ -78,5 +78,9 @@ "sidebar.tutorialSidebar.category.Login with Wallets": { "message": "Login with Wallets", "description": "The label for category Login with Wallets in sidebar tutorialSidebar" + }, + "sidebar.tutorialSidebar.category.shared": { + "message": "shared", + "description": "The label for category shared in sidebar tutorialSidebar" } }