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

    instances

    List all instances for the project or display details for a specific instance.

    List all instances for the project

    $ alto instances
    

    Display details for a single instance

    $ alto instances <instance-name>
    

    Arguments

    instance-name

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

    Required: yes

    Options

    --page

    Select a specific results page.

    Required: no

    --project-path

    Specify the project directory.

    If not specified, project directory is assumed to be the current directory.

    Aliases: --pp

    Required: no

    --project-name

    Select the project by name.

    If neither --project nor --project-name is specified, then the command must be run from an Altostra project directory.

    Required: no
    --project

    Select a project by id.

    If neither --project nor --project-name is specified, then the command must be run from an Altostra project directory.

    Aliases: -p
    Required: no

    history

    List the deployment history for a project instance.

    $ alto instances history <instance-name>
    

    Arguments

    instance-name

    The instance name.

    Required: yes

    Options

    --page

    Select a specific results page.

    Required: no
    --project-path

    Specify the project directory.

    If not specified, project directory is assumed to be the current directory.

    Aliases: --pp
    Required: no
    --project-name

    Select the project by name.

    If neither --project nor --project-name is specified, the the command must be run from an Altostra project directory.

    Required: no
    --project

    Select a project by id.

    If neither --project nor --project-name is specified, then the command must be run from an Altostra project directory.

    Aliases: -p
    Required: no

    errors

    Get the error from the latest deployment of an instance.

    $ alto instances errors <instance-name>
    

    Arguments

    instance-name

    The instance name.

    Required: yes

    Options

    --project-path

    Specify the project directory.

    If not specified, project directory is assumed to be the current directory.

    Aliases: --pp
    Required: no
    --project-path

    Specify the project directory.

    If not specified, project directory is assumed to be the current directory.

    Aliases: --pp
    Required: no
    --project-name

    Select a project by name.

    If neither --project nor --project-name is specified, then the command must be run from an Altostra project directory.

    Required: no
    --project

    Select a project by id.

    If neither --project nor --project-name is specified, then the command must be run from an Altostra project directory.

    Aliases: -p
    Required: no

    config

    Get configuration values for an instance.

    $ alto instances config <instance-name>
    

    Arguments

    instance-name

    The instance name.

    Required: no

    Options

    --project-path

    Specify the project directory.

    If not specified, project directory is assumed to be the current directory.

    Aliases: --pp
    Required: no
    --project-name

    Select a project by name.

    If neither --project nor --project-name is specified, then the command must be run from an Altostra project directory.

    Required: no
    --project

    Select a project by id.

    If neither --project nor --project-name is specified, then the command must be run from an Altostra project directory.

    Aliases: -p
    Required: no

    delete

    Delete a project instance.

    $ alto instances delete <instance-name>
    

    Arguments

    instance-name

    The instance name.

    Required: yes

    Options

    --project-path

    Specify the project directory.

    If not specified, project directory is assumed to be the current directory.

    Aliases: --pp
    Required: no
    --project-name

    Select a project by name.

    If neither --project nor --project-name is specified, then the command must be run from an Altostra project directory.

    Required: no
    --project

    Select a project by id.

    If neither --project nor --project-name is specified, then the command must be run from an Altostra project directory.

    Aliases: -p
    Required: no
    ← imagesbuild →
    • List all instances for the project
    • Display details for a single instance
      • Arguments
    • Options
      • --page
      • --project-path
      • history
      • errors
      • config
      • delete
    © 2021 Altostra, Inc.