User Guide

User Guide

Command-Line Interface (CLI)

The face-auth command is your main tool.

Enrollment

Enroll the current user:

face-auth enroll

Enroll a specific user (if you have permission):

face-auth enroll username

Options:

• --samples N: Number of photos to take (default 5).
• --no-preview: Disable the GUI preview window.

Management

List all enrolled users:

face-auth list

Remove a user:

face-auth remove username

Manage individual face samples:

face-auth view-samples username
face-auth add-sample username
face-auth remove-sample username <index>

Authentication Test

Run a test to see if it recognizes you:

face-auth test

• --timeout N: Wait N seconds for a face (default 10).

Graphical User Interface (GUI)

Launch the GUI with: Launch the GUI with:

sudo /opt/linux-hello/launch-gui.sh

The GUI allows you to:

1. Dashboard: See system status.
2. Users: Add/Remove users visually.
3. Samples: View your enrolled face entries.
4. Settings: Quick view of config.
5. Logs: See recent authentication attempts.

Monitoring Daemon

To start background monitoring (for auto-lock):

face-auth start-monitor

Stop it:

face-auth stop-monitor

Check status:

face-auth status