Altostra Docs

    ›CLI

    Getting Started

    • Welcome to Altostra
    • Connect your accounts
    • Install the developer tools
    • Log in from the CLI

    Tutorials

    • Create a Static Website
    • Create a Scalable Webhook
    • Create a Simple API Project
    • Try Altostra without connecting cloud accounts
    • CI/CD with Altostra CLI and Github Actions

    How To

      Working with projects

      • Create a new project
      • Deploy a project
      • Manage a project

      Working with environments

      • Manage an environment
      • Configure instances expiration for an environment

      Working with the Editor

      • Grant access to vendor services
      • Use the Parameter Store
      • Use a custom CloudFormation resource
      • Attach a custom policy to a Function
      • Connect a Function to VPC
      • Add filter policy to SNS subscription

      Organization account settings

      • Set General Settings
      • Connect a Git account
      • Connect Cloud Accounts
      • Manage log aggregation accounts

    CLI

    • Altostra CLI
    • Commands

      • templates
      • new
      • init
      • push
      • deploy
      • sls-deploy
      • sync
      • invalidate
      • domains
      • console
      • environments
      • images
      • instances
      • build
      • config
      • import
      • projects
      • tasks
      • activity-log
      • login
      • logout
      • account
      • whoami
      • api-key
      • docs

      Options

      • --debug
      • --verbose
      • Scripting options
    • Configuration files

    Errors And Solutions

    • Autnentication Required

    Technical Reference

    • Environments
    • Playground Environment
    • Instances
    • Project image
    • Image Repository
    • Log Shipping
    • Deployment Modes
    • Altostra Cloud Integration

    Integrations

      CI/CD

      • CircleCI

    Altostra CLI

    Manage and deploy Altostra projects from your terminal.

    Installation

    It is assumed that you have Node.js and npm installed.

    $ npm install -g @altostra/cli
    

    Using

    To run Altostra commands:

    $ alto <command> [flags] [arguments]
    

    Commands

    CommandAliasesDescription
    alto newInitialize an Altostra project in a new directory
    alto templatesget-templates, list-templatesList all available project templates
    alto initInitialize an Altostra project in the current directory
    alto pushPush a new image of the project to your Altostra repository
    alto deployDeploy an Altostra project
    alto sls-deployDeploy a Serverless Framework managed project
    alto syncUploads files to buckets
    alto invalidateClear CDN caches
    alto domainsget-domainsList the available domains for supported resources in a deployed Instance
    alto environmentsenvironment, env, envsManage Altostra environments
    alto imagesList the available published images for the project
    alto instancesinstance, deployments, deploymentManage project instances
    alto buildcompileBuild the project to an AWS SAM template and save to sam-template.json
    alto localexecute, execRun resources locally
    alto configManage local Altostra configuration
    alto importImport a project from a Git repository
    alto projectsprojectManage Altostra projects
    alto tasksList currently running tasks
    alto activity-logList recently completed tasks
    alto loginLog in to your Altostra account
    alto logoutLog out of your Altostra account
    alto accountaccounts, team, teamsSwitch between personal and team accounts
    alto whoamiShows logged-in user
    alto api-keyManage API keys
    alto consoleOpen the Altostra Web Console for the this project
    alto docsOpen the Altostra documentation

    Options

    OptionAliasDescription
    --debugLogs debug data to your temp dir
    --helpShow help for a command
    --verbose-vShow detailed information for commands to the terminal
    --versionShow the currently installed Altostra CLI version
    --textOutput results as plain text without decoration for piping to other commands
    --jsonOutput results as JSON for piping to other commands
    ← Manage log aggregation accountstemplates →
    • Installation
    • Using
    • Commands
    • Options
    © 2021 Altostra, Inc.