The CLI is accessed by running ephaptic in your terminal.

If it doesn't work, you may need to run .venv/bin/ephaptic or ~/.local/bin/ephaptic. Consider adding these to PATH.

ephaptic

Ephaptic CLI tool.

Usage:

ephaptic [OPTIONS] COMMAND [ARGS]...

Options:

  --install-completion  Install completion for the current shell.
  --show-completion     Show completion for the current shell, to copy it or
                        customize the installation.
  --help                Show this message and exit.

from-schema

Usage:

ephaptic from-schema [OPTIONS]

Options:

  --schema-path PATH       Path to the schema file.  [default: schema.json]
  -o, --output PATH        Output path for the generated file (default:
                           ephaptic.d.ts / Ephaptic.kt).
  -w, --watch              Watch for changes in `.py` files and regenerate
                           schema file automatically.
  -l, --lang TEXT          Output language ('kotlin', 'kt', 'typescript',
                           'ts') (default: autodetected from output path)
  -p, --package-name TEXT  Package name (required for Kotlin)  [default:
                           com.example.app]
  --help                   Show this message and exit.

generate

Usage:

ephaptic generate [OPTIONS] [CLIENT]

Options:

  [CLIENT]                 The import string for the Ephaptic client.
                           [default: app:client]
  -o, --output PATH        Output path for the generated file (default:
                           schema.json / ephaptic.d.ts / Ephaptic.kt).
  -w, --watch              Watch for changes in `.py` files and regenerate
                           schema file automatically.
  -l, --lang TEXT          Output language ('json', 'kotlin', 'kt',
                           'typescript', 'ts') (default: autodetected from
                           output path)
  -p, --package-name TEXT  Package name (required for Kotlin)  [default:
                           com.example.app]
  --help                   Show this message and exit.