CLI Subcommand Reference

pi_portal.cli

Door Monitor CLI.

pi_portal.cli [OPTIONS] COMMAND [ARGS]...

Options

--debug

Enable debug logs.

cron_videos

Start the video archival cron.

pi_portal.cli cron_videos [OPTIONS]

door_monitor

Start the door monitor.

pi_portal.cli door_monitor [OPTIONS]

install_config

Install a configuration file. Requires root.

CONFIG_FILE: The path to the configuration file to use.

pi_portal.cli install_config [OPTIONS] CONFIG_FILE

Options

-y, --yes

Answer “yes” to installation confirmation.

Arguments

CONFIG_FILE

Required argument

slack_bot

Connect the interactive Slack bot.

pi_portal.cli slack_bot [OPTIONS]

temp_monitor

Start the temperature monitor.

pi_portal.cli temp_monitor [OPTIONS]

upload_snapshot

Upload a snapshot image to Slack.

FILENAME: The path to the image file to upload.

pi_portal.cli upload_snapshot [OPTIONS] FILENAME

Arguments

FILENAME

Required argument

upload_video

Upload a video to Slack and S3.

FILENAME: The path to the video file to upload.

pi_portal.cli upload_video [OPTIONS] FILENAME

Arguments

FILENAME

Required argument

version

Display the Pi Portal version.

pi_portal.cli version [OPTIONS]