Documentation
📘 Commands
install

install

rfswift install

Install software and tools inside containers using predefined function scripts.

Synopsis 

rfswift install -c CONTAINER -i FUNCTION_NAME

The install command executes predefined installation functions inside containers to add software, tools, or configurations. These functions are part of RF Swift’s installation script library and handle dependencies, compilation, and setup automatically.

Options

Flag Description Required Example
-c, --container STRING Container ID or name ✅ Yes -c my_container
-i, --install STRING Function name to execute ✅ Yes -i sdrpp_soft_install

Examples

Basic Usage

Install SDR++ software:

rfswift install -c work -i sdrpp_soft_install

Install GNU Radio modules:

rfswift install -c sdr_work -i gnuradio_modules_install

Install wireless tools:

rfswift install -c wifi_analysis -i wireless_tools_install

Real-World Scenarios

Setup new SDR container:

# Create container
rfswift run -i penthertz/rfswift_noble:sdr_light -n sdr_custom

# Install additional tools
rfswift install -c sdr_custom -i sdrpp_soft_install
rfswift install -c sdr_custom -i hackrf_tools_install
rfswift install -c sdr_custom -i rtlsdr_tools_install

# Container now has custom toolset
rfswift exec -c sdr_custom

Add missing tool:

# Working in container, need additional tool
rfswift exec -c analysis
# Realize you need inspectrum
exit

# Install from host
rfswift install -c analysis -i inspectrum_install

# Tool now available
rfswift exec -c analysis
inspectrum

Batch installation:

# Install multiple tools
TOOLS=(
    "sdrpp_soft_install"
    "gqrx_install"
    "urh_install"
    "inspectrum_install"
)

for tool in "${TOOLS[@]}"; do
    echo "Installing: $tool"
    rfswift install -c sdr_full -i "$tool"
done

Custom toolchain setup:

# Create specialized container
rfswift run -i penthertz/rfswift_noble:base -n custom_rf

# Install specific tools
rfswift install -c custom_rf -i gnuradio_install
rfswift install -c custom_rf -i hackrf_tools_install
rfswift install -c custom_rf -i limesuite_install

# Commit as custom image
rfswift commit -c custom_rf -i my_custom_toolchain:v1

Troubleshooting

Installation Failed

Problem: Installation function fails

Solutions:

# Check container is running
rfswift last | grep container_name

# Check internet connectivity in container
rfswift exec -c container -e "ping -c 3 google.com"

# Check disk space
rfswift exec -c container -e "df -h"

# Try with more verbose output
rfswift exec -c container
# Run installation command manually to see errors
exit

# Update package lists first
rfswift exec -c container -e "apt-get update"

# Then retry install
rfswift install -c container -i function_name

Function Not Found

Problem: Installation function doesn’t exist

Solutions:

# Check available functions or in the documentation https://rfswift.io/docs/guide/list-of-tools/
# See RF Swift documentation or GitHub

# Verify function name spelling
rfswift install -c container -i sdrpp_soft_install  # Correct
rfswift install -c container -i sdrpp_install        # Wrong

# Update RF Swift for new functions
rfswift update

Related Commands

  • exec - Execute commands after installation
  • commit - Save container after installations
  • run - Create container for installations
  • upgrade - Upgrade container with new tools
🔧
Automated Setup: The install command uses predefined functions that handle dependencies, compilation, and configuration automatically. No need to manually compile or configure!
Internet Required: Installation functions download source code and packages from the internet. Ensure your container has network access during installation!
Commit After Installing: After installing tools, commit your container with rfswift commit to preserve your work. Otherwise, changes are lost if the container is removed!
Last updated on
completion