Skip to content

CodeCanna/jotbot

Repository files navigation

Jotbot

What is Jotbot?

Jotbot is a telegram bot that can help you to record your thoughts and emotions in directly in the telegram app.

Configuration

Jotbot uses environment variables for configuration. Copy .env.example to .env and fill in your values:

cp .env.example .env

Environment Variables

Variable Description Default
TELEGRAM_BOT_KEY Your Telegram bot token from @BotFather (required)
TELEGRAM_API_BASE_URL Custom Telegram Bot API URL https://api.telegram.org

The TELEGRAM_API_BASE_URL is useful when running behind a proxy or using a self-hosted Telegram API.

How do I use Jotbot?

Jotbot is easy to use you have to be "registered" to start recording entries. Once this is done you can use /new_entry to start recording an entry. You just answer the bot's questions to the best of you ability from there.

After you are finished recording your entry you can view your entry by using /view_entries. This will bring up a menu that let's you scroll through your entries. You can also delete entries from this screen. If you are wanting to stop using Jotbot you can delete your account using /delete_account this will also delete all of your journal entries!

Commands

/start - Start the bot, if it's your first time messaging the bot you will be asked if you want to register.

/help - Prints this help string in a message

/new_entry - Start a new entry

/view_entries - Scroll through your entries (You can also delete and edit entries from here)

/kitties - Open the kitties app! Studies show kitties can help with depression!

/delete_account - Delete your accound plus all entries

/🆘 or /sos - Show the crisis help lines

Starting a new entry

To start a new entry run the /new_entry command, and simply answer the follow up questions from the bot.

Viewing, Editing, and deleting entries

To view, edit, or delete entries use the /view_entries command. This will brind up a menu that allows you to scroll through the enries. When you scroll to an entry you want to delete or edit, press the 💣Delete💣 button to delete the currently selected entry, or the ✏️Edit Entry✏️ button to edit your entry.

When editing an entry you will be asked to copy the contents of the entry you have selected and paste it into the chat with the bot. You can then edit the entry before sending the updated entry back to the bot to save. Be careful not to edit the entry fields like Situation or Automatic Thoughts because the bot uses these the read the data. Only edit the parts of the entry that you actually typed out.

When deleting an entry you will be asked if you are sure you want to delete the entry press yes to delete or no to return to viewing entries.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •