Register a project with your private journal repository.
doraval journal initjournal init is the prerequisite command. The full journal group also includes list, add, and sync. See the design rationale for why the architecture exists.
What it does
Section titled “What it does”journal init connects a local project directory to a journal stored in a private GitHub repository (following the pattern yourname/yourname.md).
It:
- Detects a good default for your journal repo (prefers the owner of the current git remote, falls back to your active GitHub account via the
ghCLI). - Shows you exactly where the default came from.
- Remembers the journal repo you chose previously for faster setup on new projects.
- Creates the necessary local cache under
~/.doraval/. - Fetches
global.mdand your project-specific journal file from GitHub.
No files are added to your project repository. All configuration lives in your home directory.
Smart defaults
Section titled “Smart defaults”journal init tries to be helpful:
- Git remote (highest priority) — If you’re inside a git repo with a GitHub origin, it uses the owner of that repository.
- Previously used journal repo — If you’ve already run
initbefore, it defaults to the same journal repo. - Active
ghaccount — Falls back to whatevergh api userreturns.
When the git remote owner and your active GitHub account differ (common for people with both personal and work accounts), it surfaces both so you can choose easily.
Non-interactive usage
Section titled “Non-interactive usage”Fully scriptable:
doraval journal init --repo saif-shines/saif-shines.md --project doravalOr via environment variables:
DORAVAL_JOURNAL_REPO=saif-shines/saif-shines.md \DORAVAL_PROJECT=doraval \doraval journal initOptions
Section titled “Options”| Flag | Description |
|---|---|
-r, --repo | Journal repository (owner/name) |
-p, --project | Project name (defaults to current directory name) |
After running init
Section titled “After running init”Your project is now linked. Future journal commands (once implemented) will automatically know which journal to read from and write to.
See the Agent Journal concept page for the broader vision.