Note Mark
  • Support The Project
  • CLI

    How To Access

    Docker Install

    Access from the official Docker image is easy! We can just use the “exec” command from either “docker” or “docker compose”.

    Example based off install guide:

    docker compose exec note-mark /note-mark --help


    Due to using a distro-less base image interactive tty sessions with a shell (sh, bash) are not possible.

    Bare Install

    Assuming all of the environment variables are already set and Note Mark is accessible from path:

    note-mark --help

    Available Commands

    • serve: run the web API server, depending on install method may include UI
    • clean: remove old and unused data
    • user: add, remove and change user passwords
    • migrate: import and export data out of the app
    • help: shows the help for CLI