Skip to content

Commit 53bce19

Browse files
Merge pull request #913 from vexr/improve-cli-gui-guidance
Improve CLI vs GUI farming method guidance
2 parents 0c8d283 + 173bc2f commit 53bce19

File tree

3 files changed

+70
-2
lines changed

3 files changed

+70
-2
lines changed

docs/farming-&-staking/farming/intro.mdx

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,64 @@ import Badge from '@site/src/components/Badge';
3232
For those who prefer a visual guide, we have prepared installation videos to assist you. The videos will help you to set up the Space Acres <Badge variant="recommended" text="Recommended" /> farming application in under 10 minutes. Please follow [the installation videos](/farming/space-acres/install#installation-videos) to use SubWallet to create a compatible Substrate account and refer to the detailed guide on downloading and configuring Autonomys' farming application, Space Acres.
3333
:::
3434

35+
## Choosing Your Farming Method
36+
37+
Before reviewing system requirements, it's important to choose the right farming method for your needs. Autonomys offers two primary options for farming: Space Acres (GUI) and the CLI.
38+
39+
### <Icon icon={ICONS.FARMER} />Space Acres <Badge variant="recommended" text="Recommended" />
40+
41+
**Space Acres is a user-friendly, multi-platform GUI application that simplifies getting started with farming.** Available for Windows, macOS, and Linux, it offers the most common set of configuration options in an intuitive visual interface, making it perfect for beginners and most farming scenarios across all major operating systems.
42+
43+
**Why choose Space Acres:**
44+
- **Multi-platform support**: Native applications for Windows, macOS, and Linux
45+
- **Beginner-friendly**: Visual setup wizard guides you through the entire process
46+
- **Simplified configuration**: Most common farming options available through easy-to-use interface
47+
- **Real-time monitoring**: Visual dashboard shows farming progress, sector status, and rewards
48+
- **Automatic updates**: Built-in update mechanism keeps your farming software current
49+
- **Error handling**: Clear error messages and troubleshooting guidance
50+
- **No command line knowledge required**: Everything managed through the graphical interface
51+
52+
**Perfect for:**
53+
- First-time farmers getting started with the Autonomys Network
54+
- Users who prefer visual interfaces over command-line tools
55+
- Standard farming setups with typical configuration requirements
56+
- Anyone wanting a "set it and forget it" farming experience
57+
58+
### <Icon icon={ICONS.CODE} />CLI
59+
60+
**The CLI is designed for users seeking additional configuration options, advanced setups, or specialized farming scenarios.**
61+
62+
**Why choose CLI:**
63+
- **Advanced configuration**: Access to all available farming parameters and fine-tuning options
64+
- **Multiple farms with single node**: Efficiently manage multiple farm locations from one node instance
65+
- **Farming clusters**: Support for large to massive farming operations with distributed architecture
66+
- **Automation & scripting**: Easy integration with automation tools and custom scripts
67+
- **Resource optimization**: Granular control over system resource allocation
68+
- **Headless operation**: Run on servers without graphical interfaces
69+
70+
**Perfect for:**
71+
- Experienced users comfortable with command-line interfaces
72+
- Users needing specific configuration parameters not available in Space Acres
73+
- Farming clusters and enterprise deployments with distributed components (node, controller, cache, plotter, farmer) across multiple servers to optimize load distribution and accelerate plotting
74+
- Automation and integration with existing infrastructure
75+
- Headless server environments
76+
77+
### Feature Comparison
78+
79+
| Feature | Space Acres | CLI |
80+
|---------|-------------|------------|
81+
| **Ease of Use** | <Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /> Beginner-friendly | <Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /> Requires command-line knowledge |
82+
| **Setup Time** | <Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /> Quick visual setup | <Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /> Manual configuration |
83+
| **Configuration Options** | <Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /> Most common options | <Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /> All available options |
84+
| **Multiple Farms** | Not supported | <Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /> Full multi-farm support |
85+
| **Scale Support** | <Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /> Small to medium farms | <Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /> All scales including clusters |
86+
| **Monitoring** | <Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /> Visual dashboard | <Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /> Log-based monitoring |
87+
| **Resource Control** | Not configurable | <Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /><Icon icon={ICONS.STAR} /> Granular optimization |
88+
89+
**Getting Started:**
90+
- **[Space Acres Installation Guide](/farming/space-acres/install)** - Step-by-step visual setup
91+
- **[CLI Installation Guide](/farming/cli/install)** - Command-line setup instructions
92+
3593
## Operating System
3694

3795
| Application | <Icon icon={ICONS.UBUNTU} /> Ubuntu | <Icon icon={ICONS.WINDOWS} /> Windows | <Icon icon={ICONS.MACOS} /> macOS |

docs/farming-&-staking/farming/space-acres/install.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,16 @@ import LinuxPage from './platforms/_linux.mdx';
2929

3030
# <Badge variant="recommended" iconOnly /> Install Space Acres
3131

32+
Space Acres is our recommended farming application because it **simplifies getting started** with the Autonomys Network. As a user-friendly GUI application, it provides the most common configuration options through an intuitive visual interface, making farming accessible to everyone—from complete beginners to experienced users who want a streamlined experience.
33+
34+
**Why Space Acres is recommended:**
35+
- **Beginner-friendly setup**: Visual wizard guides you through the entire process
36+
- **All-in-one solution**: Node and farmer combined in a single application
37+
- **Real-time monitoring**: Visual dashboard shows your farming progress and rewards
38+
- **Simplified configuration**: Most common farming scenarios covered through easy-to-use interface
39+
40+
**Need more advanced features?** If you require multiple farms, farming clusters, or specialized configuration options not available in the GUI, consider the [CLI](/farming/cli/install) instead.
41+
3242
## Before You Begin
3343

3444
Make sure you have:

docs/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,8 +151,8 @@ You'll also notice the <Badge variant="testnet" text="Testnet" /> badge on certa
151151
Secure the network by storing archival history and earn rewards. Farmers maintain consensus, plot data to disk, and participate in the Distributed Storage Network (DSN).
152152

153153
**Getting Started:**
154-
- **[Space Acres](/farming/space-acres/install)** <Badge variant="recommended" text="Recommended" /> - User-friendly GUI application perfect for beginners, with visual setup and monitoring
155-
- **[CLI Farmer](/farming/cli/install)** - Command-line interface for advanced users seeking full control and automation capabilities
154+
- **[Space Acres](/farming/space-acres/install)** <Badge variant="recommended" text="Recommended" /> - User-friendly GUI application that simplifies farming with visual setup, monitoring, and the most common configuration options
155+
- **[CLI](/farming/cli/install)** - Command-line interface for advanced users needing multiple farms, farming clusters, or specialized configuration options
156156

157157
### <Icon icon={ICONS.NOMINATOR} />Nominators
158158
Stake your tAI3 tokens by nominating operators to increase their chances of being elected as slot leaders. Earn proportional rewards while supporting network security.

0 commit comments

Comments
 (0)