Basic Usage

Use the surfmeter command to operate Automator. On a machine with a native installation, it is available in every directory. In Docker, prefix the commands with docker exec --user surfmeter surfmeter.

Get the version:

surfmeter --version

Show the available commands, and the options of a command:

surfmeter --help
surfmeter study start --help

All commands and options are listed in the commands and options reference.

Common Commands

surfmeter auth status --verify                 # Is this client registered?
surfmeter measure https://www.wikipedia.org    # Measure a URL
surfmeter study list                           # List the configured studies
surfmeter study start --studyId STUDY_YOUTUBE  # Run a configured study
surfmeter daemon status                        # Show the schedule and recent runs
surfmeter daemon run <entryId>                 # Run a schedule entry now
surfmeter config show                          # Show the current configuration
surfmeter config update                        # Download the configuration now
surfmeter update --check                       # Check for a new version

Output

When you run a command in a terminal, it shows a progress summary and writes the full log to a file in ~/.surfmeter/logs/. To see the full log in your terminal, add --verbose. See Logging.

Next, register the client if you have not done so during the setup. Then, run a study.