SmosOptions
programs.smos.backup
Periodic local backups of the workflow directory
Type:
null or (submodule)
Default:
null
programs.smos.backup.OnCalendar
How frequently to run the local backup
Type:
string
Default:
"daily"
Example:
"weekly"
programs.smos.backup.backupDir
The directory to backup to
Type:
string
Default:
"/home/user/.local/share/smos/backup"
programs.smos.backup.enable
Whether to enable Automatic Smos workflow backups.
Type:
boolean
Default:
false
Example:
true
programs.smos.calendar
Periodic calendar imports
Type:
null or (submodule)
Default:
null
programs.smos.calendar.OnCalendar
How frequently to run the calendar import
Type:
string
Default:
"hourly"
Example:
"daily"
programs.smos.calendar.enable
Whether to enable Automatic smos calendar importing.
Type:
boolean
Default:
false
Example:
true
programs.smos.config
Typed contents of the config file
Type:
submodule
Default:
{ }
programs.smos.config.agenda
This option has no description.
Type:
submodule
Default:
{ }
programs.smos.config.agenda.hide-archive
Whether to consider archived entries
Type:
null or boolean
Default:
null
programs.smos.config.any
Keybindings for any context
Type:
null or anything
Default:
null
programs.smos.config.archive
This option has no description.
Type:
submodule
Default:
{ }
programs.smos.config.archive-dir
The archive directory
Type:
null or string
Default:
null
programs.smos.config.archive.log-level
Minimal severity of log messages
Type:
null or anything
Default:
null
programs.smos.config.archived-projects-dir
The archived projects directory
Type:
null or string
Default:
null
programs.smos.config.browser
Keybindings for the file browser context
Type:
null or (submodule)
Default:
null
programs.smos.config.browser.any
Keybindings for any of the other file browser situations
Type:
null or anything
Default:
null
programs.smos.config.browser.empty
Keybindings for when the directory being browsed is empty
Type:
null or anything
Default:
null
programs.smos.config.browser.existent
Keybindings for when an existing file or directory is selected
Type:
null or anything
Default:
null
programs.smos.config.browser.filter
Keybindings for when file browser's filter bar is selected
Type:
null or anything
Default:
null
programs.smos.config.browser.in-progress
Keybindings for when an in-progress file or directory is selected
Type:
null or anything
Default:
null
programs.smos.config.calendar
This option has no description.
Type:
submodule
Default:
{ }
programs.smos.config.calendar.log-level
Minimal severity of log messages
Type:
null or anything
Default:
null
programs.smos.config.calendar.sources
Calendar sources to import from
Type:
null or (list of (submodule))
Default:
null
programs.smos.config.calendar.sources.*.destination
The destination path within the workflow directory
Type:
string
programs.smos.config.calendar.sources.*.name
The name of the source
Type:
null or string
Default:
null
programs.smos.config.calendar.sources.*.source
the url to fetch or file to import
Type:
null or string
Default:
null
programs.smos.config.calendar.sources.*.source-file
the file that contains the url to fetch or file to import
Type:
null or string
Default:
null
programs.smos.config.clock
This option has no description.
Type:
submodule
Default:
{ }
programs.smos.config.clock.hide-archive
Whether to consider archived entries
Type:
null or boolean
Default:
null
programs.smos.config.colour
This option has no description.
Type:
submodule
Default:
{ }
programs.smos.config.colour.background
Table background colours
Type:
null or anything or (submodule)
Default:
null
programs.smos.config.entry
This option has no description.
Type:
submodule
Default:
{ }
programs.smos.config.entry.columns
The columns in the report
Type:
null or (list of anything)
Default:
null
programs.smos.config.entry.hide-archive
Whether to consider archived entries
Type:
null or boolean
Default:
null
programs.smos.config.entry.sorter
A sorter to sort entries by
Type:
null or anything or list of anything
Default:
null
programs.smos.config.explainer-mode
Activate sandbox mode to ensure that smos can only edit smos files
Type:
null or boolean
Default:
null
programs.smos.config.file
Keybindings for the file context
Type:
null or (submodule)
Default:
null
programs.smos.config.file.any
Keybindings that match in any file subcontext
Type:
null or anything
Default:
null
programs.smos.config.file.contents
Keybindings for when an contents is selected
Type:
null or anything
Default:
null
programs.smos.config.file.empty
Keybindings for when the file is empty
Type:
null or anything
Default:
null
programs.smos.config.file.entry
Keybindings for when an entry is selected
Type:
null or anything
Default:
null
programs.smos.config.file.header
Keybindings for when an header is selected
Type:
null or anything
Default:
null
programs.smos.config.file.logbook
Keybindings for when a logbook is selected
Type:
null or anything
Default:
null
programs.smos.config.file.properties
Keybindings for when a properties are selected
Type:
null or anything
Default:
null
programs.smos.config.file.state-history
Keybindings for when a state history is selected
Type:
null or anything
Default:
null
programs.smos.config.file.tags
Keybindings for when a tags are selected
Type:
null or anything
Default:
null
programs.smos.config.file.timestamps
Keybindings for when a timestamps are selected
Type:
null or anything
Default:
null
programs.smos.config.free
This option has no description.
Type:
submodule
Default:
{ }
programs.smos.config.free.hide-archive
Whether to consider archived entries
Type:
null or boolean
Default:
null
programs.smos.config.github
This option has no description.
Type:
submodule
Default:
{ }
programs.smos.config.github.oauth-token
OAuth token for contacting GitHub
Type:
null or string
Default:
null
programs.smos.config.github.oauth-token-file
Path to an OAuth token for contacting GitHub
Type:
null or string
Default:
null
programs.smos.config.goal
The goal for initialised projects
Type:
null or anything
Default:
null
programs.smos.config.help
Keybindings for the help context
Type:
null or (submodule)
Default:
null
programs.smos.config.help.any
Keybindings for at any time in the help screen
Type:
null or anything
Default:
null
programs.smos.config.help.help
Keybindings for when in the help screen
Type:
null or anything
Default:
null
programs.smos.config.help.search
Keybindings for when the search bar is selected within the help screen
Type:
null or anything
Default:
null
programs.smos.config.jobhunt
This option has no description.
Type:
submodule
Default:
{ }
programs.smos.config.jobhunt.directory
The directory to put jobhunt projects in, relative to the projects dir
Type:
null or string
Default:
null
programs.smos.config.jobhunt.email
This option has no description.
Type:
submodule
Default:
{ }
programs.smos.config.jobhunt.email.from
This option has no description.
Type:
submodule
Default:
{ }
programs.smos.config.jobhunt.email.from.address
From address
Type:
null or string
Default:
null
programs.smos.config.jobhunt.email.from.name
From name
Type:
null or string
Default:
null
programs.smos.config.jobhunt.email.smtp
This option has no description.
Type:
submodule
Default:
{ }
programs.smos.config.jobhunt.email.smtp.password
SMTP server password
Type:
null or string
Default:
null
programs.smos.config.jobhunt.email.smtp.password-file
SMTP server password file
Type:
null or string
Default:
null
programs.smos.config.jobhunt.email.smtp.port
SMTP server port
Type:
null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
programs.smos.config.jobhunt.email.smtp.server
SMTP server domain
Type:
null or string
Default:
null
programs.smos.config.jobhunt.email.smtp.username
SMTP server username
Type:
null or string
Default:
null
programs.smos.config.jobhunt.email.template
This option has no description.
Type:
submodule
Default:
{ }
programs.smos.config.jobhunt.email.template.html
Template for the HTML version of the email
Type:
null or string
Default:
null
programs.smos.config.jobhunt.email.template.subject
Template for the subject of the email
Type:
null or string
Default:
null
programs.smos.config.jobhunt.email.template.text
Template for the text version of the email
Type:
null or string
Default:
null
programs.smos.config.jobhunt.log-level
Minimal severity of log messages
Type:
null or anything
Default:
null
programs.smos.config.jobhunt.waiting-threshold
The waiting threshold initialised projects
Type:
null or anything
Default:
null
programs.smos.config.log
This option has no description.
Type:
submodule
Default:
{ }
programs.smos.config.log-level
Minimal severity of log messages
Type:
null or anything
Default:
null
programs.smos.config.log.hide-archive
Whether to consider archived entries
Type:
null or boolean
Default:
null
programs.smos.config.next
This option has no description.
Type:
submodule
Default:
{ }
programs.smos.config.next.hide-archive
Whether to consider archived entries
Type:
null or boolean
Default:
null
programs.smos.config.notify
This option has no description.
Type:
submodule
Default:
{ }
programs.smos.config.notify.database
Path to database file
Type:
null or string
Default:
null
programs.smos.config.notify.log-level
Minimal severity of log messages
Type:
null or anything
Default:
null
programs.smos.config.notify.notify-send
Path to notify-send executable
Type:
null or string
Default:
null
programs.smos.config.ongoing
This option has no description.
Type:
submodule
Default:
{ }
programs.smos.config.ongoing.hide-archive
Whether to consider archived entries
Type:
null or boolean
Default:
null
programs.smos.config.projects-dir
The projects directory
Type:
null or string
Default:
null
programs.smos.config.report
This option has no description.
Type:
submodule
Default:
{ }
programs.smos.config.report.reports
available reports
Type:
null or (attribute set of (submodule))
Default:
null
programs.smos.config.report.reports.<name>.columns
The columns of the report
Type:
null or (list of anything)
Default:
null
programs.smos.config.report.reports.<name>.description
A description of the report
Type:
null or string
Default:
null
programs.smos.config.report.reports.<name>.filter
The entry filter to get the results in the report
Type:
null or anything
Default:
null
programs.smos.config.report.reports.<name>.hide-archive
Whether to consider the archive for the report
Type:
null or boolean
Default:
null
programs.smos.config.report.reports.<name>.sorter
The sorter to sort the rows of the report by
Type:
null or anything
Default:
null
programs.smos.config.reports
Keybindings for the reports context
Type:
null or (submodule)
Default:
null
programs.smos.config.reports.any
Keybindings for at any point in any report
Type:
null or anything
Default:
null
programs.smos.config.reports.next-action
Keybindings for the interactive next action report
Type:
null or (submodule)
Default:
null
programs.smos.config.reports.next-action.any
Keybindings for at any point in the next-action report
Type:
null or anything
Default:
null
programs.smos.config.reports.next-action.normal
Keybindings for interacting with the next-action report
Type:
null or anything
Default:
null
programs.smos.config.reports.next-action.search
Keybindings for the search in the next-action report
Type:
null or anything
Default:
null
programs.smos.config.reports.ongoing
Keybindings for the interactive ongoing report
Type:
null or (submodule)
Default:
null
programs.smos.config.reports.ongoing.any
Keybindings for at any point in the ongoing report
Type:
null or anything
Default:
null
programs.smos.config.reports.ongoing.normal
Keybindings for interacting with the ongoing report
Type:
null or anything
Default:
null
programs.smos.config.reports.ongoing.search
Keybindings for the search in the ongoing report
Type:
null or anything
Default:
null
programs.smos.config.reports.stuck
Keybindings for the interactive stuck projects report
Type:
null or (submodule)
Default:
null
programs.smos.config.reports.stuck.any
Keybindings for at any point in the stuck report
Type:
null or anything
Default:
null
programs.smos.config.reports.stuck.normal
Keybindings for interacting with the stuck report
Type:
null or anything
Default:
null
programs.smos.config.reports.timestamps
Keybindings for the interactive timestamps report
Type:
null or (submodule)
Default:
null
programs.smos.config.reports.timestamps.any
Keybindings for at any point in the timestamps report
Type:
null or anything
Default:
null
programs.smos.config.reports.timestamps.normal
Keybindings for interacting with the timestamps report
Type:
null or anything
Default:
null
programs.smos.config.reports.timestamps.search
Keybindings for the search in the timestamps report
Type:
null or anything
Default:
null
programs.smos.config.reports.waiting
Keybindings for the interactive waiting report
Type:
null or (submodule)
Default:
null
programs.smos.config.reports.waiting.any
Keybindings for at any point in the waiting report
Type:
null or anything
Default:
null
programs.smos.config.reports.waiting.normal
Keybindings for interacting with the waiting report
Type:
null or anything
Default:
null
programs.smos.config.reports.waiting.search
Keybindings for the search in the waiting report
Type:
null or anything
Default:
null
programs.smos.config.reports.work
Keybindings for the interactive work report
Type:
null or (submodule)
Default:
null
programs.smos.config.reports.work.any
Keybindings for at any point in the work report
Type:
null or anything
Default:
null
programs.smos.config.reports.work.normal
Keybindings for interacting with the work report
Type:
null or anything
Default:
null
programs.smos.config.reports.work.search
Keybindings for the search in the work report
Type:
null or anything
Default:
null
programs.smos.config.reset
Whether to reset all keybindings. Set this to false to add keys, set this to true to replace keys.
Type:
null or boolean
Default:
null
programs.smos.config.scheduler
This option has no description.
Type:
submodule
Default:
{ }
programs.smos.config.scheduler.schedule
Schedule on which to schedule projects
Type:
null or (attribute set of (submodule))
Default:
null
programs.smos.config.scheduler.schedule.<name>.description
A description of this item
Type:
null or string
Default:
null
programs.smos.config.scheduler.schedule.<name>.destination
The file to copy to (relative, inside the workflow directory)
Type:
string
programs.smos.config.scheduler.schedule.<name>.schedule
The schedule on which to do the copying
Type:
anything or string
programs.smos.config.scheduler.schedule.<name>.template
The file to copy from (absolute or relative, inside the workflow directory)
Type:
string
programs.smos.config.stuck
This option has no description.
Type:
submodule
Default:
{ }
programs.smos.config.stuck.threshold
The threshold at which to color stuck projects red
Type:
null or anything
Default:
null
programs.smos.config.sync
This option has no description.
Type:
submodule
Default:
{ }
programs.smos.config.sync.backup-dir
The directory to store backups in when a sync conflict happens
Type:
null or string
Default:
null
programs.smos.config.sync.cache-dir
The directory to cache state data in
Type:
null or string
Default:
null
programs.smos.config.sync.contents-dir
The directory to synchronise
Type:
null or string
Default:
null
programs.smos.config.sync.data-dir
The directory to store state data in
Type:
null or string
Default:
null
programs.smos.config.sync.empty-directories
What to do with empty directories after syncing
Type:
null or one of "remove", "keep"
Default:
null
programs.smos.config.sync.ignore-files
Which files to ignore
Type:
null or one of "nothing", "hidden"
Default:
null
programs.smos.config.sync.log-level
Minimal severity of log messages
Type:
null or anything
Default:
null
programs.smos.config.sync.metadata-db
The file to store the synchronisation metadata database in
Type:
null or string
Default:
null
programs.smos.config.sync.password
The password to login to the sync server
Type:
null or string
Default:
null
programs.smos.config.sync.password-file
The password to login to the sync server
Type:
null or string
Default:
null
programs.smos.config.sync.server-url
The server to sync with
Type:
null or string
Default:
null
programs.smos.config.sync.session-path
The path to store the login session
Type:
null or string
Default:
null
programs.smos.config.sync.username
The username to login to the sync server
Type:
null or string
Default:
null
programs.smos.config.sync.uuid-file
The file to store the server uuid in
Type:
null or string
Default:
null
programs.smos.config.tags
This option has no description.
Type:
submodule
Default:
{ }
programs.smos.config.tags.hide-archive
Whether to consider archived entries
Type:
null or boolean
Default:
null
programs.smos.config.waiting
This option has no description.
Type:
submodule
Default:
{ }
programs.smos.config.waiting.hide-archive
Whether to consider archived entries
Type:
null or boolean
Default:
null
programs.smos.config.waiting.threshold
The threshold at which to color waiting entries red
Type:
null or anything
Default:
null
programs.smos.config.work
This option has no description.
Type:
submodule
Default:
{ }
programs.smos.config.work.base-filter
The base work filter
Type:
null or anything
Default:
null
programs.smos.config.work.checks
Checks for the work report
Type:
null or (list of anything)
Default:
null
programs.smos.config.work.columns
The columns in the report
Type:
null or (list of anything)
Default:
null
programs.smos.config.work.context
The context that you are in
Type:
null or string
Default:
null
programs.smos.config.work.contexts
Contexts for the work report
Type:
null or (attribute set of anything)
Default:
null
programs.smos.config.work.filter
A filter to filter entries by
Type:
null or anything or list of anything
Default:
null
programs.smos.config.work.hide-archive
Whether to consider archived entries
Type:
null or boolean
Default:
null
programs.smos.config.work.sorter
A sorter to sort entries by
Type:
null or anything or list of anything
Default:
null
programs.smos.config.work.time
A filter to filter by time
Type:
null or anything
Default:
null
programs.smos.config.work.time-filter
The property to use to filter by time
Type:
null or anything
Default:
null
programs.smos.config.workflow-dir
The workflow directory
Type:
null or string
Default:
null
programs.smos.enable
Whether to enable Smos.
Type:
boolean
Default:
false
Example:
true
programs.smos.extraConfig
Extra contents of the config file
Type:
unspecified value
Default:
{ }
programs.smos.github
Smos GitHub
Type:
null or (submodule)
Default:
null
programs.smos.github.enable
Whether to enable Enable smos-github.
Type:
boolean
Default:
false
Example:
true
programs.smos.jobhunt
Smos Jobhunt
Type:
null or (submodule)
Default:
null
programs.smos.jobhunt.enable
Whether to enable Enable smos-jobhunt.
Type:
boolean
Default:
false
Example:
true
programs.smos.notify
Desktop notifications
Type:
null or (submodule)
Default:
null
programs.smos.notify.OnCalendar
How frequently to run the notifier
Type:
string
Default:
"minutely"
Example:
"*:0/2"
programs.smos.notify.enable
Whether to enable Automatic smos desktop notifications.
Type:
boolean
Default:
false
Example:
true
programs.smos.notify.notify-send
The package containing notify-send
Type:
package
Default:
<derivation libnotify-0.8.3>
programs.smos.scheduler
Automatic scheduled project scheduling
Type:
null or (submodule)
Default:
null
programs.smos.scheduler.OnCalendar
How frequently to run the scheduler
Type:
string
Default:
"hourly"
Example:
"daily"
programs.smos.scheduler.enable
Whether to enable Automatic smos scheduler activation.
Type:
boolean
Default:
false
Example:
true
programs.smos.smosReleasePackages
The smosPackages attribute defined in the nix/overlay.nix file in the smos repository.
Type:
attribute set
Default:
{
smos = <derivation smos-0.10.1>;
smos-api = <derivation smos-api-0.8.0>;
smos-api-gen = <derivation smos-api-gen-0.3.2>;
smos-archive = <derivation smos-archive-0.7.1>;
smos-calendar-import = <derivation smos-calendar-import-0.10.0>;
smos-cli = <derivation smos-cli-0.2.1>;
smos-client = <derivation smos-client-0.6.0>;
smos-cursor = <derivation smos-cursor-0.7.0>;
smos-cursor-gen = <derivation smos-cursor-gen-0.2.2>;
smos-data = <derivation smos-data-0.7.0>;
smos-data-gen = <derivation smos-data-gen-0.5.1>;
smos-directory = <derivation smos-directory-0.2.0>;
smos-directory-gen = <derivation smos-directory-gen-0.2.0>;
smos-docs-site = <derivation smos-docs-site-0.0.0>;
smos-e2e = <derivation smos-e2e-0.8.3>;
smos-github = <derivation smos-github-0.9.0>;
smos-jobhunt = <derivation smos-jobhunt-0.2.0>;
smos-notify = <derivation smos-notify-0.5.0>;
smos-query = <derivation smos-query-0.12.0>;
smos-report = <derivation smos-report-0.12.0>;
smos-report-cursor = <derivation smos-report-cursor-0.6.1>;
smos-report-cursor-gen = <derivation smos-report-cursor-gen-0.4.0>;
smos-report-gen = <derivation smos-report-gen-0.8.0>;
smos-scheduler = <derivation smos-scheduler-0.10.1>;
smos-server = <derivation smos-server-0.14.2>;
smos-server-gen = <derivation smos-server-gen-0.9.1>;
smos-single = <derivation smos-single-0.4.0>;
smos-stripe-client = <derivation smos-stripe-client-0.1.0.0>;
smos-sync = <derivation smos-sync-0.8.0>;
smos-sync-gen = <derivation smos-sync-gen-0.4.2>;
smos-web-assets = <derivation smos-web-assets-0.0.2>;
smos-web-server = <derivation smos-web-server-0.14.3>;
}
programs.smos.sync
Periodic local backups of the workflow directory
Type:
null or (submodule)
Default:
null
programs.smos.sync.OnCalendar
How frequently to run the synchronisation
Type:
string
Default:
"hourly"
Example:
"daily"
programs.smos.sync.enable
Whether to enable Automatic smos workflow synchronisation.
Type:
boolean
Default:
false
Example:
true
programs.smos.workflowDir
Smos' workflow directory
Type:
string
Default:
"/home/user/workflow"