Documentation
🚀 Quick Start

🚀 Quick Start

⚠ī¸
On Linux, unless your are using Docker Desktop, you will have to use rfswift with sudo most of the time.

To install RF Swift, you have to choice using the pre-compiled binary wrapper depending on your system and pull an existing container image, or to compile the Go project and/or the Docker images from sources.

In this section, we will go straight forward to the quickest way to run the project.

Get binary from GitHub

Get the latest binary from the official repository ↗.

Rename the binary to rfswift to make things simplier.

If you run the binary without config, the tool will ask you if you want to create one or use values by default:

rfswift 
Config file not found. Would you like to create one with default values? (y/n)

Pulling a built image

RF Swift have already some prebuilt images you can fire on the go.

For the example, we will pull an image containing a complete SDR images penthertz/rfswift:sdr_full on an x86_64 architecture:

rfswift images pull -i penthertz/sdr_light [-t myrfswift:label]

Important options:

  • i: remote label
  • t: optional local tag we want to use.
ℹī¸
Using Docker Desktop (Windows and macOS) or OrbStack on macOS, sudo is not necessary.

Running the container

After downloading the image, you can create and run the container by precising the tag with -i assigned to the image and the name with -n of the container:

rfswift run -i penthertz/rfswift:sdr_light -n supercontainername
ℹī¸
The name of the container will allow to restart it without having to remember its ID.

And there you can execute all programs installed on it ;)!

As an example, plug an supported SDR devices in your computer, and inside the command shell sdrpp.

⚠ī¸
The sound could be maybe missing, we will see other options the rfswift, but if you follow the warnings you will probably see that ./rfswift host audio enable will solve the issues if pulseaudio is well running on your host.

Restarting a container

You can create as many fresh container you want, but sometimes you want to get back to previous job.

To restart a container, you can do it with the following command using -c nameofthecontainer:

rfswift exec -c supercontainername
ℹī¸

On Unix-Like systems, consider using an alias, if you want to start the binary from any location with rfswift command ;)

  echo "alias rfswift='<BINARY_PATH>/rfswift'" >> "$HOME/.<shell>rc" # example /home/user/.bashrc

Next

Dive right into the following section to get started:

Follow the guide
Read the guide and learn how to use RF Swift for your dealy assessments.
Last updated on
Getting started📖 Guide