Skip to content

[Feature]: Jump directly to a mode and source from the CLI #15

Closed

Description

@mahlquistj

Is there an existing issue for this?

  • I have searched the existing issues

Feature

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>:<value>" --param "<param2_name>:<value>"

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?)

Activity

  1. self-assigned this
    on Sep 15, 2025
  2. added this to the 1.0 milestone on Oct 31, 2025
  3. shadowmkj commented on Aug 6, 2026

    @shadowmkj
    Contributor

    Is there an existing issue for this?

    • I have searched the existing issues

    Feature

    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?

  4. mahlquistj commented on Aug 7, 2026

    @mahlquistj
    OwnerAuthor

    @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

  5. shadowmkj commented on Aug 10, 2026

    @shadowmkj
    Contributor

    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 quality
    could you please review it when you get a chance?

  6. mahlquistj commented on Aug 10, 2026

    @mahlquistj
    OwnerAuthor

    I'll review very soon! I'm just preparing for some vacation currently 😊

    And thank you for contributing! 😁

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions