Running marvin

Activate the virtual environment

If you have not created a virtual environment yet, click here.

If you are not already within the virtual environment, run:

Linux and Mac

    $ cd ./marvin
    $ source venv/bin/activate

You should now see (venv) user@host:~$. This means you are within the virtual environment. For reference, all commands that start with (venv) require you to be within the virtual environment.

Windows

• Open a command prompt and navigate to the folder where you cloned marvin.

    C:\...\marvin> cmd /k .\venv\Scripts\activate

You should now see (venv) C:\...\marvin>. This means you are within the virtual environment. For reference, all commands that start with (venv) require you to be within the virtual environment.

Standalone (Recommended for development)

Linux and Mac

    (venv)$ ./run_standalone.py

Stop the bot with Ctrl+C then answer y and hit Enter when prompted to quit. Running in this mode only requires MongoDB to be running.

Windows

    (venv) C:\...\marvin> run_standalone.py

Stopping the bot with Ctrl+C has not been tested and is not guaranteed to work.

Daemon

Linux and Mac

To start the bot

(venv)$ ./marvind start

To stop the bot:

(venv)$ ./marvind stop

To tail the logs:

(venv)$ ./marvind bot_log

Windows

Running marvin as a daemon has not been tested and is not guaranteed to work.

Shell

Linux and Mac

If you want a shell and a great debugger:

(venv)$ ./marvind shell

Windows

The marvin shell has not been tested in this platform and is not guaranteed to work.

---

Installing plugins

Now that you have successfully completed the running steps, you can now continue installing plugins for marvin. (Click Here)

Other references:

• Telegram API documentation
• python-telegram-bot documentation