Modal

[ngupta23]

Overview

API Reference

• Documentation

Playground

• Try out your code snippets here.

Examples

• Examples here.

Deployment

• Refrence

Secrets and Environment Variables

• Refrence

Webhooks (endpoints)

• Refrence

Commands

Setting & activating the token

• Profile >> Settings >> {Go to right workspace} >> API Tokens >> New Token
• Run this command to store the token on your computer.
• Refer to the documentation about configuration for how to set credentials via environment variables instead.

# set the token
modal token set --token-id {token-id} --token-secret {token-secret} --profile={profile-name}

# This stores the token in a profile named {profile-name}. To activate, run:
modal profile activate {profile-name}

Working with containers

Once the profile has been activated, you can connect to a container in that workspace and run commands as follows.

# list the containers
modal container list

# connect to a container and open a shell
modal container exec {container-id} /bin/bash /bin/bash

NOTE: if you do not see your container in the list, you can find the container ID from modal website directly.

1. Go to the Apps and click on the app
2. Under "Overview" click on the "App Functions"
3. Click "Containers"
4. Click on one that is "Live". The ID will be displayed there.