You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
[Feature]: Jump directly to a mode and source from the CLI #15
To allow using octotype from scripts or other shortcuts, it would be nice to have the ability to supply a set of arguments like the following, to instantly start a session:
We could also allow just passing in: --mode <mode_name> and start at the source-selection screen.
The same goes for --mode <mode_name> --source <source_name>, which would start at parameter configuration.
Maybe also add a --end-after-session which tells octotype to close when a user is done with a session (I guess, done with viewing their stats?)
To allow using octotype from scripts or other shortcuts, it would be nice to have the ability to supply a set of arguments like the following, to instantly start a session:
octotype --mode "<mode_name>" --source "<source_name>" --param "<param1_name>:" --param "<param2_name>:"
We could also allow just passing in: --mode <mode_name> and start at the source-selection screen. The same goes for --mode <mode_name> --source <source_name>, which would start at parameter configuration.
Maybe also add a --end-after-session which tells octotype to close when a user is done with a session (I guess, done with viewing their stats?)
When --mode <mode_name> --source <source_name> is given, wouldn't it start the typing?
What do you mean by parameter configuration?
As modes and sources can have parameters, you might want to be able to specify what the parameters should be - E.g. for a custom mode that has a parameter that specifies how many words to type:
I've opened pr #70 implementing the CLI arguments (--mode, --source, --param) to allow jumping directly into sessions and parameter overrides, also did cargo fmt and clippy for formatting and code quality
could you please review it when you get a chance?
Activity
shadowmkj commentedon Aug 6, 2026
When
--mode <mode_name> --source <source_name>is given, wouldn't it start the typing?What do you mean by parameter configuration?
mahlquistj commentedon Aug 7, 2026
@shadowmkj
As modes and sources can have parameters, you might want to be able to specify what the parameters should be - E.g. for a custom mode that has a parameter that specifies how many words to type:
octotype --mode custom_mode --source random_quotes --param "words_to_type:50"See docs for parameters here:
https://mahlquistj.github.io/octotype/docs/configuration/modes#parameters
https://mahlquistj.github.io/octotype/docs/configuration/sources#parameters
shadowmkj commentedon Aug 10, 2026
Hey @mahlquistj,
I've opened pr #70 implementing the CLI arguments (
--mode,--source,--param) to allow jumping directly into sessions and parameter overrides, also did cargo fmt and clippy for formatting and code qualitycould you please review it when you get a chance?
mahlquistj commentedon Aug 10, 2026
I'll review very soon! I'm just preparing for some vacation currently 😊
And thank you for contributing! 😁