Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Getting Started

First-Time Setup

After installing rscontacts and placing your OAuth2 credentials, authenticate:

rscontacts auth

This opens your browser for Google OAuth2 consent. The token is cached at ~/.config/rscontacts/token_cache.json for future use.

If you’re on a headless machine:

rscontacts auth --no-browser

This prints the auth URL instead of opening a browser.

Basic Usage

List all contacts:

rscontacts list

Include email addresses:

rscontacts list --emails

Show phone labels (mobile/home/work):

rscontacts list --labels

Running Checks

Run all checks at once:

rscontacts check-all

Get a summary of issues:

rscontacts check-all --stats

Fix issues interactively:

rscontacts check-all --fix

Preview what would change without modifying anything:

rscontacts check-all --fix --dry-run

Inspecting a Contact

Show all details for a specific contact:

rscontacts show-contact "John"

This does a case-insensitive substring search and displays all available fields.