Skip to content

Commands

Run swelog --help, or swelog <command> --help, to see this information from the CLI itself.

A Rust CLI to track your daily accomplishments in Obsidian.

Terminal window
swelog <COMMAND>
Command Description
init Create a default swelog config file
setup Setup the swelog files in your Obsidian vault
summarize Summarize your configured work file. By default, this is an alias for swelog summarize day
log Write your work file into a dated daily log
reset Reset your work file to the default content
undo Undo your last swelog log, swelog summarize day, or swelog reset
fetch Add data from external sources to your work file
config Display your current swelog configuration and where it is stored
auth Manage the credentials swelog stores in your operating system keyring
help Print this message or the help of the given subcommand(s)
Flag Description
--config <PATH> Custom path to a swelog config file
-h, --help Print help
-V, --version Print version

Create a default swelog config file.

Terminal window
swelog init [OPTIONS]
Flag Description
--force Overwrite an existing config file with defaults
-h, --help Print help

Setup the swelog files in your Obsidian vault.

Terminal window
swelog setup [OPTIONS]
Flag Description
--force Overwrite existing swelog files
-h, --help Print help

Summarize your configured work file. By default, this is an alias for swelog summarize day.

Terminal window
swelog summarize [OPTIONS] [COMMAND]
Command Description
day Summarize your configured work file and log it into the daily folder
week Summarize the past week of daily logs into a weekly log
help Print this message or the help of the given subcommand(s)
Flag Description
--date <MM-DD-YYYY> Date to write the daily log for in the format MM-DD-YYYY. Defaults to today
--yesterday Write the daily log for yesterday instead of today
--last-friday Write the daily log for last Friday instead of today
--force Overwrite existing daily log file
--keep Keep the current contents of the configured work file
-h, --help Print help

Summarize your configured work file and log it into the daily folder.

Terminal window
swelog summarize day [OPTIONS]
Flag Description
--date <MM-DD-YYYY> Date to write the daily log for in the format MM-DD-YYYY. Defaults to today
--yesterday Write the daily log for yesterday instead of today
--last-friday Write the daily log for last Friday instead of today
--force Overwrite existing daily log file
--keep Keep the current contents of the configured work file
-h, --help Print help

Summarize the past week of daily logs into a weekly log.

Terminal window
swelog summarize week [OPTIONS]
Flag Description
--week-of <MM-DD-YYYY> The Monday of the week you want to summarize in the format MM-DD-YYYY
--last-week Summarize the previous week instead of the week containing today
--force Overwrite existing weekly log file
-h, --help Print help

Write your work file into a dated daily log.

Terminal window
swelog log [OPTIONS]
Flag Description
--date <MM-DD-YYYY> Date to write the daily log for in the format MM-DD-YYYY. Defaults to today
--yesterday Write the daily log for yesterday instead of today
--last-friday Write the daily log for last Friday instead of today
--force Overwrite existing daily log file
--keep Keep the current contents of the configured work file
-h, --help Print help

Reset your work file to the default content.

Terminal window
swelog reset
Flag Description
-h, --help Print help

Undo your last swelog log, swelog summarize day, or swelog reset.

Terminal window
swelog undo
Flag Description
-h, --help Print help

Add data from external sources to your work file.

Terminal window
swelog fetch <COMMAND>
Command Description
all Run every fetch command you have configured a credential for
github Fetch the PRs you opened, merged, closed, and reviewed on a date in GitHub
linear Fetch the Linear issues assigned to your configured Linear username
google-calendar Fetch the meetings on your Google Calendar for a date
status Show which fetch commands swelog fetch all will run
help Print this message or the help of the given subcommand(s)
Flag Description
-h, --help Print help

Run every fetch command you have configured a credential for. The sources are fetched concurrently, then recorded in your work file one at a time in the order listed.

Terminal window
swelog fetch all [OPTIONS]
Flag Description
--date <MM-DD-YYYY> Date to fetch activity for in the format MM-DD-YYYY
--yesterday Fetch activity for yesterday instead of today
--last-friday Fetch activity for last Friday instead of today
-h, --help Print help

Fetch the PRs you opened, merged, closed, and reviewed on a date in GitHub.

Terminal window
swelog fetch github [OPTIONS]
Flag Description
--date <MM-DD-YYYY> Date to fetch GitHub activity for in the format MM-DD-YYYY
--yesterday Fetch GitHub activity for yesterday instead of today
--last-friday Fetch GitHub activity for last Friday instead of today
-h, --help Print help

Fetch the Linear issues assigned to your configured Linear username.

Terminal window
swelog fetch linear [OPTIONS]
Flag Description
--date <MM-DD-YYYY> Date to fetch Linear activity for in the format MM-DD-YYYY
--yesterday Fetch the Linear issues you worked on yesterday
--last-friday Fetch the Linear issues you worked on last Friday
-h, --help Print help

Fetch the meetings on your Google Calendar for a date.

Terminal window
swelog fetch google-calendar [OPTIONS]
Flag Description
--date <MM-DD-YYYY> Date to fetch Google Calendar meetings for in the format MM-DD-YYYY
--yesterday Fetch the meetings you had yesterday
--last-friday Fetch the meetings you had last Friday
-h, --help Print help

Show which fetch commands swelog fetch all will run.

Terminal window
swelog fetch status
Flag Description
-h, --help Print help

Display your current swelog configuration and where it is stored.

Terminal window
swelog config
Flag Description
-h, --help Print help

Manage the credentials swelog stores in your operating system keyring.

Terminal window
swelog auth <COMMAND>
Command Description
status Show which credentials swelog has stored in your operating system keyring
clear Remove a stored credential so the next command asks for it again
help Print this message or the help of the given subcommand(s)
Flag Description
-h, --help Print help

Show which credentials swelog has stored in your operating system keyring.

Terminal window
swelog auth status
Flag Description
-h, --help Print help

Remove a stored credential so the next command asks for it again.

Terminal window
swelog auth clear [OPTIONS] [CREDENTIAL]
Argument Description
[CREDENTIAL] Credential to remove from your operating system keyring. Possible values: github, open-ai, open-router, anthropic, linear, google-calendar
Flag Description
--all Remove every credential swelog has stored
-h, --help Print help