### Start Development Environment

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/custom_tool_guides/slack.md

Command to start the backend and frontend services for development. This command typically orchestrates the build and run process for both parts of the application.

```bash
make dev
```

--------------------------------

### Initial Development Setup Commands

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/troubleshooting.md

Lists essential commands for setting up the development environment for the first time, including database migrations.

```bash
make migrate
make dev
```

--------------------------------

### Install and Run ngrok

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/src/interfaces/slack_bot/README.md

Instructions for installing ngrok via Homebrew and starting an HTTP tunnel to expose a local server (port 3000) to the public internet. This is crucial for receiving Slack events during development.

```shell
brew install ngrok
ngrok http 3000
```

--------------------------------

### Run Development Environment

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/custom_tool_guides/gmail.md

This command initiates the backend and frontend development servers, allowing you to run and test the integrated Gmail tool. It's the final step after all configurations are completed.

```bash
make dev
```

--------------------------------

### Configuration YAML

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/custom_tool_guides/github.md

Example configuration for the Github tool in YAML format, specifying default repositories and user scopes.

```yaml
github:
    default_repos: 
      - repo1
      - repo2
    user_scopes: 
      - public_repo
      - read:org
```

--------------------------------

### Ngrok Command for Local Development

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/custom_tool_guides/gmail.md

This command starts Ngrok to create a secure tunnel to your local development environment, allowing external services to access your local server. It's crucial for configuring OAuth redirect URIs when running locally.

```bash
ngrok http -domain <your_custom_domain>.ngrok.dev 8000
```

--------------------------------

### Running Sharepoint Tool Development Environment

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/custom_tool_guides/sharepoint.md

Command to start the backend and frontend for the Sharepoint tool development environment.

```bash
make dev
```

--------------------------------

### Azure App Service Deployment

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/service_deployments.md

Guide for deploying the Cohere Toolkit on Azure App Service using Docker compose. It covers DB instance setup and container deployment to Azure App Service.

```markdown
## Azure App Service compose
   Help setup your DB instance, then build, push, and deploy Toolkit containers to Azure App Service using Docker compose.
```

--------------------------------

### Local Setup with Make

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/README.md

Clones the Cohere Toolkit repository and runs the initial setup using the provided Makefile. This simplifies the development workflow.

```bash
git clone https://github.com/cohere-ai/cohere-toolkit.git
cd cohere-toolkit
make first-run
```

--------------------------------

### Sharepoint Tool Redirect URI Example

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/custom_tool_guides/sharepoint.md

Example of a redirect URI for the Sharepoint tool's application registration in the Microsoft Entra Admin Center.

```bash
https://<your_backend_url>/v1/tool/auth
```

--------------------------------

### Development Setup

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/custom_tool_guides/github.md

Command to run the backend and frontend for the Github tool development environment.

```bash
make dev
```

--------------------------------

### Install psycopg2-binary

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/troubleshooting.md

Replaces psycopg2 with psycopg2-binary in pyproject.toml to resolve PEP 517 build errors during installation.

```bash
psycopg2-binary
```

--------------------------------

### Running the Setup Command in Slack

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/src/interfaces/slack_bot/README.md

Once the bot is installed and authorized, you must run the `/setup-command` within your Slack workspace to enable its core functionalities. This command registers necessary settings for the bot. In production, only administrators can run this; in development (`NODE_ENV=development`), restrictions are lifted.

```shell
/setup-command
```

--------------------------------

### Initial Setup with Make

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/setup.md

Executes the 'first-run' make target to generate configuration files and apply initial database migrations.

```bash
make first-run
```

--------------------------------

### Install PostgreSQL on macOS

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/troubleshooting.md

Installs PostgreSQL using Homebrew on macOS to resolve 'pg_config' executable not found errors.

```bash
brew install postgresql
```

--------------------------------

### Example Database URL

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/deployment_guides/aws_deployment.md

An example of a fully configured database URL for the current deployment.

```env
postgresql+psycopg2://postgres:postgres@toolkit-app-db.dev.toolkit-app.local:5432
```

--------------------------------

### Google Cloud Platform Deployment

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/service_deployments.md

Guide to deploying the Cohere Toolkit on Google Cloud Platform. It covers setting up Cloud SQL, building, pushing, and deploying backend and frontend containers to Cloud Run.

```markdown
## Google Cloud Platform
   Help setup your Cloud SQL instance, then build, push, and deploy backend + frontend containers to Cloud Run.
```

--------------------------------

### Frontend Development HTTPS Configuration (package.json)

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/custom_tool_guides/slack.md

Configuration within the frontend's package.json to enable experimental HTTPS during local development. This is necessary when the backend is configured to use HTTPS with a self-signed certificate.

```json
"scripts": {
    "dev": "NODE_TLS_REJECT_UNAUTHORIZED=0 next dev --port 4000 --experimental-https",
..........
}
```

```json
"scripts": {
    "dev": "NODE_TLS_REJECT_UNAUTHORIZED=0 next dev --port 4000",
..........
}
```

--------------------------------

### Start Cohere Toolkit Application

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/github_codespaces.md

Builds and starts the Cohere Toolkit application using the `make up` command. This command is typically used to launch the services defined in the project's Makefile.

```makefile
make up
```

--------------------------------

### Environment Variable Setup

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/command_model_providers.md

This snippet shows how to enable community features by setting an environment variable. This is necessary for using local models with LlamaCPP.

```bash
# .env file
USE_COMMUNITY_FEATURES=True
```

--------------------------------

### Running Unit Tests

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/src/backend/tests/unit/README.md

Commands to install dependencies, set up the test database, and execute unit tests.

```bash
make install
make test-db
make run-unit-tests
```

--------------------------------

### Environment Variables (.env)

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/custom_tool_guides/github.md

Example environment variable configuration for the Github tool in .env format, including client ID, client secret, default repositories, and user scopes.

```dotenv
GITHUB_CLIENT_ID=<your_client_id from step 1>
GITHUB_CLIENT_SECRET=<your_client_secret from step 1>
GITHUB_DEFAULT_REPOS=["repo1","repo2"]
GITHUB_USER_SCOPES=["public_repo","read:org"]
```

--------------------------------

### Development Dependencies and Testing

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/setup.md

Commands to install development dependencies, spin up a test database, and run the project's tests.

```bash
make install
```

```bash
make test-db
make run-tests
```

--------------------------------

### Configuration File Structure

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/setup.md

Example structure for configuration and secrets files, highlighting key parameters.

```yaml
# configuration.yaml
cohere_platform:
  api_key: "YOUR_COHERE_API_KEY"
database:
  url: "postgresql://user:password@host:port/database"
redis:
  url: "redis://localhost:6379"
```

```yaml
# secrets.yaml
# Contains sensitive information, typically not committed to version control.
# Example:
# cohere_platform:
#   api_key: "your_actual_api_key"
```

--------------------------------

### Start ngrok for Local Development

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/src/interfaces/slack_bot/README.md

Starts the ngrok service to expose your local development environment (port 3000) to the public internet, allowing Slack webhooks to reach your bot.

```shell
ngrok http 3000
```

--------------------------------

### AWS Copilot Deployment

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/service_deployments.md

Guide for deploying the Cohere Toolkit on Amazon Web Services using AWS Copilot. It includes setting up the DB instance and deploying containers to ECS Fargate.

```markdown
## Amazon Web Services AWS Copilot
   Help setup your DB instance, then build, push, and deploy Toolkit containers to ECS Fargate using AWS Copilot.
```

--------------------------------

### Slack App Configuration and Installation

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/src/interfaces/slack_bot/README.md

Details on configuring the Slack App with the public ngrok URL and how to install the app to a workspace. This involves setting the 'Request URL' in Slack's Event Subscriptions and appending '/slack/install' to the ngrok URL.

```APIDOC
Slack App Configuration:
  Event Subscriptions:
    - Ensure event subscriptions are enabled.
    - Set 'Request URL' to your bot's events hook (e.g., https://<your-ngrok-url>/slack/events).
  OAuth Permissions:
    - Grant necessary OAuth permissions for the bot.

Slack App Installation:
  - Append '/slack/install' to your ngrok URL to install the app to a workspace.
  - Example: https://<your-ngrok-url>/slack/install
```

--------------------------------

### Backend Hostname Configuration (HTTPS)

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/custom_tool_guides/slack.md

Configuration for the backend hostname, setting the protocol to HTTPS. This ensures that the frontend and other services communicate with the backend using a secure connection.

```bash
NEXT_PUBLIC_API_HOSTNAME=https://localhost:8000
```

--------------------------------

### Backend Hostname Configuration (YAML)

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/custom_tool_guides/slack.md

Configuration for the backend hostname in YAML format, setting the protocol to HTTPS. This ensures that the frontend and other services communicate with the backend using a secure connection.

```yaml
auth:
    backend_hostname: https://localhost:8000
```

--------------------------------

### Install Community Dependency

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/custom_tool_guides/tool_guide.md

Command to add a new library for community tools using Poetry.

```bash
poetry add <MODULE> --group community
```

--------------------------------

### Slack Environment Variables (.env)

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/custom_tool_guides/slack.md

Configuration for Slack API credentials using a .env file. These variables store the Client ID and Client Secret obtained from the Slack app credentials, which are necessary for authentication.

```bash
SLACK_CLIENT_ID=<your_client_id from step 1>
SLACK_CLIENT_SECRET=<your_client_id from step 1>
```

--------------------------------

### Helm Chart Installation

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/charts/cohere-toolkit/README.md

Command to install the Cohere Toolkit Helm chart. It specifies the chart location, namespace, configuration file, and includes options for waiting for deployment and setting a timeout.

```shell
helm install cohere-toolkit ./helm/cohere-toolkit \
  --create-namespace \
  -n cohere-toolkit \
  -f ./helm/cohere-toolkit/values/local.yaml \
  --wait --timeout 30s
```

--------------------------------

### Minikube Cluster Creation

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/charts/cohere-toolkit/README.md

Command to start a Minikube cluster, which is a prerequisite for deploying the Helm chart locally.

```shell
minikube start
```

--------------------------------

### Database Connection String Example

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/github_migrations_action.md

An example of a database connection string format used for configuring the `MIGRATION_DATABASE_URL` secret in GitHub Actions. This format is typically used by ORMs like SQLAlchemy.

```Plaintext
postgresql+psycopg2://username:password@host:port/database
```

--------------------------------

### Development and Production Commands

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/src/interfaces/coral_web/README.md

Commands to start the Cohere Chat interface in development or production modes, and for linting.

```shell
pnpm dev

pnpm build

pnpm start

pnpm lint
```

--------------------------------

### Enable Community Features

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/troubleshooting.md

Instructs on how to enable community features by setting an environment variable in the .env file.

```bash
USE_COMMUNITY_FEATURES=True
```

--------------------------------

### Set Google Cloud API Key in .env

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/text_to_speech.md

This code snippet shows how to set the Google Cloud API key in a .env file for authentication.

```bash
GOOGLE_CLOUD_API_KEY=<your_api_key>
```

--------------------------------

### Secrets YAML

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/custom_tool_guides/github.md

Example secrets configuration for the Github tool in YAML format, including client ID and client secret.

```yaml
github:
    client_id: <your_client_id from step 1>
    client_secret: <your_client_secret from step 1>
```

--------------------------------

### Cloning the Repository

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/setup.md

Steps to clone the Cohere toolkit repository and navigate into the project directory.

```bash
git clone <repository-url>
cd <repository-folder>
```

--------------------------------

### Rebuild Codespace Container

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/github_codespaces.md

Rebuilds the Docker container for the GitHub Codespace. This is a troubleshooting step that can resolve issues related to environment setup or package installations.

```bash
Codespaces: Rebuild Container
```

--------------------------------

### Docker Compose API Hostname Override

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/custom_tool_guides/slack.md

Override for the API_HOSTNAME in the docker-compose.yml for the frontend service. This ensures the frontend uses the correct local HTTPS URL for the backend.

```yaml
API_HOSTNAME: https://localhost:8000
```

--------------------------------

### Local Setup with Docker Compose

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/README.md

Clones the Cohere Toolkit repository and uses Docker Compose to spin up the container environment. It also includes a command to apply database migrations.

```bash
git clone https://github.com/cohere-ai/cohere-toolkit.git
cd cohere-toolkit
docker compose up
docker compose run --build backend alembic -c src/backend/alembic.ini upgrade head
```

--------------------------------

### Slack App Manifest Configuration

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/src/interfaces/slack_bot/README.md

This section details the process of creating a Slack application using an app manifest. It emphasizes copying the contents of `example-manifest.yaml` and the importance of updating placeholder URLs like `https://slack-bot-host/slack/events` with your actual deployment or ngrok domain.

```yaml
--- 
# Example Slack App Manifest
# Replace https://slack-bot-host with your actual domain

display_information:
  name: "Command Bot"
  description: "A bot to execute commands in Slack"
  background_color: "#0077d9"

features:
  bot_user:
    display_name: "Command"
    always_online: true

services:
  slash_commands:
    - command: "/setup-command"
      url: "https://slack-bot-host/slack/setup"
      description: "Setup the command bot"
  events:
    - url: "https://slack-bot-host/slack/events"
  oauth_callbacks:
    - url: "https://slack-bot-host/slack/oauth_redirect"

# ... other manifest configurations
```

--------------------------------

### Generate SSL Certificate

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/custom_tool_guides/slack.md

Command to generate a self-signed SSL certificate and private key for local HTTPS development. This is crucial for enabling secure communication during local testing of the Slack tool integration.

```bash
openssl req -x509 -newkey rsa:4096 -nodes -out cert.pem -keyout key.pem -days 365
```

--------------------------------

### Environment Variables for Gmail Credentials (.env)

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/custom_tool_guides/gmail.md

This snippet demonstrates how to set Gmail API credentials directly in a `.env` file using `GMAIL_CLIENT_ID` and `GMAIL_CLIENT_SECRET`. This is an alternative method to `secrets.yaml` for configuring authentication.

```bash
GMAIL_CLIENT_ID=<your_client_id from the previous step>
GMAIL_CLIENT_SECRET=<your_client_secret from the previous step>
```

--------------------------------

### Environment Variables for Gmail Credentials (secrets.yaml)

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/custom_tool_guides/gmail.md

This snippet shows how to configure Gmail API credentials by setting `client_id` and `client_secret` in a `secrets.yaml` file. These variables are essential for the application to authenticate with the Gmail API.

```yaml
Gmail:
    client_id: <your_client_id from the previous step>
    client_secret: <your_client_secret from the previous step>
```

--------------------------------

### Slack Environment Variables (YAML)

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/custom_tool_guides/slack.md

Configuration for Slack API credentials using a YAML file. These variables store the Client ID and Client Secret obtained from the Slack app credentials, which are necessary for authentication.

```yaml
slack:
    client_id: <your_client_id from step 1>
    client_secret: <your_client_secret from step 1>
```

--------------------------------

### gcloud CLI Authentication and Project Selection

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/deployment_guides/gcp_deployment.md

Authenticates the gcloud CLI with your Google Cloud account and prompts you to select the project where the PostgreSQL database was provisioned.

```bash
gcloud auth login
```

--------------------------------

### Docker Compose Frontend Environment Variables

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/custom_tool_guides/slack.md

Docker Compose configuration for the frontend service, setting environment variables for API hostnames. This ensures the frontend correctly points to the backend, especially when using HTTPS locally.

```yaml
frontend:
    build:
      target: ${BUILD_TARGET:-prod}
      context: ./src/interfaces/assistants_web
      dockerfile: Dockerfile
    environment:
      API_HOSTNAME: https://backend:8000
      NEXT_PUBLIC_API_HOSTNAME: https://localhost:8000
...........
```

--------------------------------

### Database Migration Creation

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/setup.md

Command to create a new database migration file with a descriptive message.

```bash
make migration message="Your migration message"
```

--------------------------------

### Backend Dockerfile HTTPS Configuration

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/custom_tool_guides/slack.md

Modifications to the backend Dockerfile to include the generated SSL certificate and key, and to configure the Uvicorn server to use HTTPS. This enables the backend to serve traffic securely over HTTPS locally.

```Dockerfile
COPY pyproject.toml poetry.lock cert.pem key.pem ./
CMD uvicorn backend.main:app --reload --host 0.0.0.0 --port ${PORT} --timeout-keep-alive 300 --ssl-keyfile /workspace/key.pem --ssl-certfile /workspace/cert.pem
```

--------------------------------

### Initialize Cohere Toolkit Environment

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/github_codespaces.md

Executes the initialization script to set up the development environment for the Cohere Toolkit within a Codespace. This script handles necessary project-specific setup tasks.

```bash
sh .devcontainer/init.sh
```

--------------------------------

### Cohere Platform Deployment

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/command_model_providers.md

This snippet demonstrates how to deploy Cohere Command models using the Cohere Platform. It requires the Cohere Python SDK and a Cohere API key.

```python
from cohere_toolkit.model_deployments.cohere_platform import CoherePlatformDeployment

# Assuming you have your Cohere API key set as an environment variable
# or passed directly
cohere_deployment = CoherePlatformDeployment()

# Example usage (replace with actual model and prompt)
# response = cohere_deployment.predict(model='command', prompt='Hello world!')
# print(response)
```

--------------------------------

### Disable Gmail Tool Exclusion for Base Agent (tools.ts)

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/custom_tool_guides/gmail.md

This TypeScript code snippet demonstrates how to enable the Gmail tool for the base agent by removing `TOOL_GMAIL_ID` from the `BASE_AGENT_EXCLUDED_TOOLS` array in the `tools.ts` file. By default, it is excluded.

```typescript
export const BASE_AGENT_EXCLUDED_TOOLS = [];
```

--------------------------------

### Linting and Formatting Commands

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/setup.md

Commands for linting the codebase and automatically fixing formatting issues.

```bash
make lint
```

```bash
make lint-fix
```

--------------------------------

### PyCharm Debugging Command

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/debugging.md

This bash command starts the Toolkit API in a debug mode suitable for PyCharm's remote debugging setup. This command should be executed within the project's root directory.

```bash
make pycharm-debug
```

--------------------------------

### Slack Redirect URL Configuration

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/custom_tool_guides/slack.md

Specifies the redirect URL for the Slack OAuth flow. This URL is used by Slack to send authorization codes back to your application after a user grants permission. Ensure your backend is accessible at this URL.

```bash
https://<your_backend_url>/v1/tool/auth
```

```bash
https://localhost:8000/v1/tool/auth
```

--------------------------------

### Enable Gmail Tool in Frontend Constants (tools.ts)

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/custom_tool_guides/gmail.md

This TypeScript code snippet shows how to enable the Gmail tool in the frontend by adding `TOOL_GMAIL_ID` to the `AGENT_SETTINGS_TOOLS` array in the `tools.ts` file. This makes the Gmail tool available in the user interface.

```typescript
export const AGENT_SETTINGS_TOOLS = [
  TOOL_HYBRID_WEB_SEARCH_ID,
  TOOL_PYTHON_INTERPRETER_ID,
  TOOL_WEB_SCRAPE_ID,
  TOOL_GMAIL_ID,
];
```

--------------------------------

### Call Backend API (Streaming)

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/how_to_guides.md

This example demonstrates how to call the Cohere Toolkit's backend API for streaming chat responses using `curl`. It includes setting the User-Id and Content-Type headers, and sending a JSON payload with the user's message.

```bash
curl --location 'http://localhost:8000/v1/chat-stream' \
--header 'User-Id: me' \
--header 'Content-Type: application/json' \
--data '{
    "message": "Tell me about the aya model"
}'
```

--------------------------------

### Initiating Slack OAuth Flow

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/src/interfaces/slack_bot/README.md

After creating the Slack app and configuring environment variables, you need to complete the OAuth flow to grant permissions. This is done by visiting an installation URL, which can be customized with a password using the `SLACK_INSTALL_PASSWORD` environment variable.

```shell
# Default install URL:
# https://slack-bot-host/slack/install/

# If SLACK_INSTALL_PASSWORD is set (e.g., to 'mysecretpassword'):
# https://slack-bot-host/slack/install/mysecretpassword

# Note: Replace 'slack-bot-host' with your deployed domain or ngrok URL.
```

--------------------------------

### Loading Environment Variables in Development

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/src/interfaces/slack_bot/README.md

Instructions on how to load environment variables during development using a `.env` file. It suggests copying the example `.env` file and editing it with specific Slack App credentials.

```shell
cp .env.example .env
# edit .env with values from your Slack App
```

--------------------------------

### Database Migration Commands

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/setup.md

Commands for migrating the database to the latest schema and for resetting and migrating the database.

```bash
make migrate
```

```bash
make reset-db
make migrate
```

--------------------------------

### Custom Parameter Definition Example

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/custom_tool_guides/tool_guide.md

Example of defining custom parameters for a tool, which are used by the system to generate prompts for the tool.

```python
parameter_definitions={
    "query": {
        "description": "Query for retrieval.",
        "type": "str",
        "required": True,
    }
},
```

--------------------------------

### Connect to PostgreSQL and Create Database/User

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/src/interfaces/slack_bot/README.md

Shell commands to connect to a PostgreSQL instance and create a new database and user for the Slack bot, granting necessary privileges.

```shell
psql --host=localhost --port=5432 --username=postgres
```

```sql
CREATE DATABASE commandslackdb;
CREATE USER commandslack WITH PASSWORD 'password';
GRANT ALL PRIVILEGES ON DATABASE commandslackdb TO commandslack;
ALTER USER commandslack WITH CREATEDB;
```

--------------------------------

### Cohere Toolkit API Migration Endpoint Example

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/docs/github_migrations_action.md

An example of the format for the Cohere Toolkit API migrations endpoint URL, which is used for the `MIGRATION_API_ENDPOINT` secret.

```Plaintext
https://<Your Cohere Toolkit hostname>:<API port, 8000 by default>/migrate
```

--------------------------------

### Run Prisma Database Migrations

Source: https://github.com/cohere-ai/cohere-toolkit/blob/main/src/interfaces/slack_bot/README.md

Executes Prisma database migrations to apply the schema changes to your PostgreSQL database.

```shell
prisma migrate dev
```