Getting Started

After installation, you'll need to configure the sync agent with your recipes folder and log in to your Cook.md account. Cook Sync provides both a graphical interface via the system tray and a command line interface.

First Launch

When you first start Cook Sync, a welcome wizard will guide you through the setup:

  1. Choose your recipes folder - Select where you keep your Cooklang recipe files
  2. Log in to Cook.md - Click the login button to authenticate in your browser
  3. Start syncing - The agent will begin syncing your recipes

System Tray

Cook Sync lives in your system tray (menu bar on macOS), showing sync status at a glance. Click the icon to see details, access settings, or trigger actions like login and sync.

Command Line

All actions are also available via the command line. To start the sync agent:

cook-sync start

The agent will start running in the background and appear in your system tray.

Logging In

Log in via the system tray menu, or from the command line:

cook-sync login

This will open your default browser where you can sign in securely. Once authenticated, the browser will redirect back and your session will be saved.

Configuration

Setting Your Recipes Directory

Tell the sync agent where your recipe files are located:

cook-sync config --recipes-dir ~/Documents/CookRecipes

Enabling Auto-Start

To have the sync agent start automatically when you log in:

cook-sync config --auto-start true

Viewing Current Configuration

To see your current settings:

cook-sync config --show

Configuration Files

Configuration is stored in these locations:

  • macOS: ~/Library/Application Support/cook-sync/
  • Linux: ~/.config/cook-sync/
  • Windows: %APPDATA%\cook-sync\

Command Line Reference

Here are all the available CLI commands:

Command Description
cook-sync start Start the sync agent
cook-sync stop Stop the running agent
cook-sync status Show sync status and configuration
cook-sync login Open browser for login
cook-sync logout Log out and clear session
cook-sync config Configure settings (see options below)
cook-sync update Check for and install updates
cook-sync reset Reset all configuration and data

Config Options

  • --recipes-dir <path> - Set recipes directory
  • --auto-start <true/false> - Enable/disable auto-start
  • --auto-update <true/false> - Enable/disable auto-update
  • --show - Display current configuration

Auto-Updates

Cook Sync automatically checks for updates and notifies you when new versions are available.

The update mechanism varies by installation method:

  • DMG (macOS): Updates via built-in updater
  • Windows: Built-in updater via cook-sync update
  • AppImage (Linux): Built-in updater via cook-sync update

To manually check for updates:

cook-sync update

Having issues? Check out the Troubleshooting page for common problems and solutions.