Altostra Docs

    ›Commands

    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

      Git

      • Git integration
      • Connect a GitHub account
      • Connect a Bitbucket account

    environments

    Aliases: environment, env, envs

    Manage Altostra environments

    Sub-Commands

    get

    Aliases: list

    List all available environments for your Altostra account.

    List all environments

    $ alto environments list
    

    Display details for a single environment

    $ alto environments get <environment-name>
    
    Arguments
    environment-name

    The name of the environment for which to print the details.

    Required: no

    create

    Create a new environment.

    $ alto environments create new-environment
    
    Arguments
    environment-name

    The environment name.

    Required: yes
    --region

    The region that the environment represents.

    Required: no
    --account

    The account that the environment represents.

    Required: no
    --expiration-minutes

    The expiration time in minutes after which instances in the environmentare automatically deleted.

    Required: no

    update

    Aliases: set

    Update an environment.

    Update environment

    $ alto environments update <environment-name> \
      --name new-name \
      --description "Env description" \
      --expiration-minutes 60
    

    Clear environment description

    $ alto environments update <environment-name> --no-description
    

    Clear environment expiration

    $ alto environments update <environment-name> --no-expiration-minutes
    
    Arguments
    environment-name

    The environment name.

    Required: yes
    Options
    --name

    Set a new name for the environment.

    Required: no
    --description

    Set a description for the environment.

    Required: no
    Aliases: --desc
    --no-description

    Clear the environment description.

    Required: no
    Aliases: --no-desc
    --expiration-minutes

    The expiration time in minutes for instances deployed to the environment.

    Required: no
    Aliases: --expiration, --exp
    --no-expiration-minutes

    Clear the expiration time for instances in the environment.

    Required: no
    Aliases: --no-expiration, --no-exp

    update-params

    Aliases: set-params

    Update environment parameters.

    Update single environment parameter

    $ alto environments update-params <environment-name> \
      --key param-name \
      --value "Parameter value"
    

    Update environment parameters from file

    $ alto environments update-params <environment-name> --file parameters.json
    

    Update environment parameters from STDIN

    $ alto environments update-params <environment-name> --file -
    
    Arguments
    environment-name

    The environment name.

    Required: yes
    Options
    --key

    The parameter key.

    Required: no
    --value

    The parameter value.

    Required: no
    --file

    The name of a JSON file to read parameters from.
    Use - to read from STDIN.

    Required: no

    parameters

    Aliases: params

    Get environment parameters.

    $ alto environments parameters <environment-name> 
    
    Arguments
    environment-name

    The environment name.

    Required: no

    projects

    List projects deployed to an environment.

    $ alto environments projects <environment-name> 
    
    Arguments
    environment-name

    The environment name.

    Required: no

    delete

    Delete the environment.

    $ alto environments delete <environment-name> 
    
    Arguments
    environment-name

    The environment name.

    Required: no
    ← consoleimages →
    • Sub-Commands
      • get
      • create
      • update
      • update-params
      • parameters
      • projects
      • delete

    Ready to Get Started?

    Get Started for Free
    © 2021 Altostra, Inc.