Documentation

Getting Started

Before installation, ensure you have the following prerequisites:

Prerequisites

• Python 3.9 or higher
• Node.js v22.0 or higher
• npm v10.0 or higher
• AWS CLI configured with appropriate permissions

Installation Steps

1. Unzip the downloaded file
2. Open terminal in the unzipped folder
3. Run installation command:

   bash install.sh

AWS IAM Setup

Configure your IAM user with the necessary permissions:

1. Navigate to AWS Console → IAM → Policies
2. You will find these JSON files in the downloaded ZIP folder. Simply copy and paste them into your AWS IAM policies section. Create new policies using provided JSON files:
   • permissions-policies-titan.json
   • permissions-boundary-titan.json
3. Attach policies to your IAM user

Basic Usage

Titan CLI provides three main commands that perform essential actions. All commands must be run in the terminal, opened in the project folder:

# Set up the project environment
titan setup-env

# Deploy all functions
titan deploy-main

# Deploy a specific version
titan deploy v5.0

Details:

• titan setup-env: This command initializes the environment by creating all necessary folders and files in the correct format. It can also update the folder structure if changes are detected.
• titan deploy-main: Deploys all Lambda functions in the current project folder.
• titan deploy v5.0: Deploys a specific version of the project (e.g., version v5.0).

Settings File

Titan CLI automatically generates and manages a JSON settings file, which contains essential configuration details for your project. This file provides:

• API links for deployed functions
• Required libraries for each function
• Project metadata (e.g., version, project name, IAM role)
• Runtime environments for each function

The settings file is automatically updated after each deployment or when running the titan setup-env command. There is no need to manually edit or create this file.

{
    "project_name": "test_project",
    "version": "v5.0",
    "role": {
        "name": "test_project_role",
        "arn": "arn:aws:iam::5436вам48:role/test_project_role"
    },
    "packages": {
        "function2": [
            "json",
            "datetime",
            "math",
            "requests"
        ],
        "function3": [],
        "function4": [
            "https",
            "lodash",
            "moment",
            "crypto",
            "querystring"
        ],
        "function1": []
    },
    "api_links": {
        "function2": "https://f64fваu6.execute-api.us-east-2.amazonaws.com/default",
        "function3": "https://xcвамta.execute-api.us-east-2.amazonaws.com/default",
        "function4": "https://aciвамx5.execute-api.us-east-2.amazonaws.com/default",
        "function1": "https://7ckвам5b.execute-api.us-east-2.amazonaws.com/default"
    },
    "runtime": {
        "function2": "python3.9",
        "function3": "python3.9",
        "function4": "nodejs16.x",
        "function1": "nodejs16.x"
    }
}

This file is crucial for managing deployments and ensuring that each function is properly configured with its dependencies, runtime, and API links.

Project Structure

After setup, your project will have the following automatically created structure. There is no need to manually configure or create it:

project/
├── api/           # Place your function files here
├── settings.json  # Automatically generated configuration and API links
└── history/       # Automatically maintained version history

You only need to add your API files to the api/ folder. Titan CLI will handle the rest automatically, including configuration, versioning, and deployment setup.