Quick Start
Installation
Section titled “Installation”Install from binary releases
Section titled “Install from binary releases”For most users, the easiest path is downloading a release binary:
- Repository:
https://github.com/demohiiiii/rauto - Releases:
https://github.com/demohiiiii/rauto/releases
Install from Crates.io
Section titled “Install from Crates.io”cargo install rautoBuild from source
Section titled “Build from source”git clone https://github.com/demohiiiii/rauto.gitcd rautocargo build --releaseThe built binary will be available at target/release/rauto.
First command
Section titled “First command”rauto uses the linux profile by default, so starting with a Linux host is the easiest first step:
rauto exec "uname -a" \ --host 192.168.1.10 \ --username root \ --password '******'If the target is a network device such as Cisco or Huawei, explicitly set --device-profile:
rauto exec "show version" \ --host 192.168.1.1 \ --username admin \ --password '******' \ --device-profile ciscoLaunch the local web console
Section titled “Launch the local web console”rauto web --bind 127.0.0.1 --port 3000Then open http://127.0.0.1:3000 in your browser.
The web console is useful for:
- managing connections, templates, and command flow templates
- running commands, transactions, workflows, and orchestration
- viewing async tasks, recordings, blacklists, and backups
Recommended minimal onboarding path
Section titled “Recommended minimal onboarding path”1. Test connectivity first
Section titled “1. Test connectivity first”rauto connection test \ --host 192.168.1.1 \ --username admin \ --password '******' \ --device-profile cisco2. Save a reusable connection profile
Section titled “2. Save a reusable connection profile”rauto connection add core-sw-01 \ --host 192.168.1.1 \ --username admin \ --ssh-port 22 \ --device-profile cisco \ --ssh-security balancedThen reuse it by name:
rauto exec "show version" --connection core-sw-013. List available device profiles
Section titled “3. List available device profiles”rauto device listBuilt-in profiles come from rneter. Common examples include:
- network vendors such as
cisco,huawei,h3c,juniper,fortinet, andarista - servers such as
linux
Common pitfalls
Section titled “Common pitfalls”The default profile is linux
Section titled “The default profile is linux”If you are connecting to a network device rather than a Linux host, explicitly set:
--device-profile ciscoupload requires SFTP support on the target
Section titled “upload requires SFTP support on the target”rauto upload is best for Linux or similar hosts that expose the sftp subsystem. Many network devices do not.
Saved connections help early
Section titled “Saved connections help early”Once you move into templates, flows, transactions, and orchestration, using --connection <name> keeps commands shorter and more reusable.