Skip to content

4. Start Stop & Schedule Game

Jump to bottom
Kevin L. edited this page Aug 5, 2024 · 1 revision

CLI

Start/Stop & Schedule Game

To start, stop, or schedule the start or stop of Honkai: Star Rail, the following commands are provided.

  1. Start Game
  2. Stop Game
  3. Schedule Start/Stop

1. Start Game

To start Honkai: Star Rail from the terminal, run:

> starrail start


2. Stop Game

To stop Honkai: Star Rail from the terminal, run:

> starrail stop


3. Schedule Start/Stop

To schedule the start/stop of Honkai: Star Rail at a given time, you may use the scheduler supplied in the starrail package.

To view the scheduler's help panel, run:

> starrail schedule
Example Command                                    Description
----------------------------------------           ----------------------------------------------
starrail schedule add --time 10:30 --action start  Schedule Honkai Star Rail to START at 10:30 AM
starrail schedule add --time 15:30 --action stop   Schedule Honkai Star Rail to STOP  at 3:30 PM
starrail schedule remove                           Remove an existing scheduled job
starrail schedule show                             Show all scheduled jobs and their details
starrail schedule clear                            Cancel all scheduled jobs (irreversible)

Supported Scheduler Commands (see usage below)

  1. Show Schedule
  2. Add/Remove Schedule
  3. Remove Schedule
  4. Clear (remove all) Schedules

Important

For the scheduled tasks to run, a StarRail CLI instance must remain open.

  • The scheduler is only active (will run scheduled tasks) when a StarRail CLI instance is open.
  • The scheduler is "paused" (will not run scheduled tasks) when the StarRail CLI instance is exited.

To start the StarRail CLI, run:

> starrail

1. Show Schedule

To show all scheduled start/stop tasks, run:

> starrail schedule show
  ID  Type           Action      Next Run             Last Run
----  -------------  ----------  -------------------  ----------
   1  Scheduled Job  Start Game  2024-08-01 10:30:00  None
   2  Scheduled Job  Stop Game   2024-08-01 15:30:00  None

2. Add Schedule

To add (schedule) a task to START Honkai: Star Rail at 10:30 AM, run:

> starrail schedule add --time 10:30 --action start

To add (schedule) a task to STOP Honkai: Star Rail at 3:30 PM, run:

> starrail schedule add --time 15:30 --action stop

Note

  • Argument --time: Time of the scheduled task
  • Argument --action: Action (start or stop)

You may also use argument --help to list all argument options

starrail schedule add --help

3. Remove Schedule

To remove a scheduled task from the scheduler, run:

> starrail schedule remove

... and then follow the steps onscreen to remove the schedule.

4. Clear (remove all) Schedule

To clear (remove all) scheduled tasks, run:

> starrail schedule clear

Caution

Any scheduled task removed / cleared cannot be recovered.

Clone this wiki locally