Octo Reminder makes it easy to create reminders in your GitHub issues and pull requests.

Simply use @set-reminder in your comment and Octo Reminder will set up a reminder for you.

⚙️ Easy Configuration

Create a .github/octo-reminder.yml configuration file in your repo to customize Octo Reminder.

Don't want to create a configuration for each repository?
Create a .github repository and save your .github/octo-reminder.yml configuration here to make it global.

🌐 Language Support

You don't speak English? Don't worry, Octo Reminder supports a variety of languages:

• English
• French
• German
• Portuguese
• Dutch
• Japanese

💅 Custom Commands

Use custom commands to set up your reminders.

It's okay if you don't like the @set-reminder command. You can define your custom command in the configuration.

Octo Reminder is currently in public beta

Installation

1. Install Octo Reminder
2. Set up your language and timzone in the configuration (see below for details).

Configuration

You can set up your configuration either globally or per repository.

Global

1. Create a .github repository (private or public)
2. In this repository, create a new file: .github/octo-reminder.yml

Per Repository

Just create a new file .github/octo-reminder.yml in the repository where you want to apply your configuration. This file will override your global configuration.

octo-reminder.yml

# Octo Reminder Configuration

## Command Prefix
### Define the prefix of your custom command.
### Type: '/' | '!'
### Default: '@' (works only in combination with command_name 'set-reminder')
command_prefix: '@'

## Command Name
### Define the name of your custom command.
### Type: String
### Default: 'set-reminder'
command_name: 'set-reminder'

## Language
### Define the language.
### Type: 'en' | 'fr' | 'de' | 'pt' | 'nl' | 'ja'
### Default: 'en'
language: 'en'

## Timezone
### Define the timezone.
### Type: String (see also https://github.com/moment/moment-timezone/blob/develop/data/packed/latest.json)
### Default: 'Europe/London'
timezone: 'Europe/London'

## Default Hour
### Define the hour that will be used, when no time is specified.
### Type: Number
default_hour: 0

## Default Minute
### Define the minute that will be used, when no time is specified.
### Type: Number
default_minute: 0

Usage

@set-reminder [date] [message]

Examples:

@set-reminder tomorrow look again at this issue

@set-reminder 2022-01-01 happy new year 🎉

@set-reminder monday 1pm

Support

Having troubles with Octo Reminder? Open a new issue here.