Skip to content
OwnStats Docs

The 'installation' command

The installation command is used to create an installation on your local machine. It will use the code from the main branch of the OwnStats repository to create an installation.

Usage

Terminal window
USAGE
  $ ownstats installation ACTION -p <value> -n <value> [-d]


ARGUMENTS
  ACTION  (create) The installation action to perform


FLAGS
  -d, --createDir     Create directory if it does not exist
  -n, --name=<value>  (required) The name of the installation to create
  -p, --path=<value>  (required) An absolute path where a new OwnStats installation shall be created in


DESCRIPTION
  Create a local Ownstats installation from the repository

Example usage

For example, if you want to create an installation in your home directory, you can run the following command:

Terminal window
ownstats installation create -d -p ~/ -n ownstats-installation

This will create a new directory called ownstats-installation in your home directory (assuming you’re on a Unix-like operating system), and initialize a new OwnStats installation in it.

.ownstats.json

After creating an installation, you will find a .ownstats.json file in the installation directory. This file contains the basic configuration for your OwnStats installation, before you have deployed any stacks.

{
    "id": "6rei7ft0",
    "name": "owntest",
    "version": "0.0.1",
    "createdTimestamp": "2025-01-10T20:34:45.953Z",
    "lastUpdatedTimestamp": "2025-01-10T20:45:23.314Z",
    "aws": {
        "stage": "prd",
        "region": "us-east-1",
        "profile": "default"
    },
    "stacksDeployed": {
        "backend": false
    },
    "cognito": {},
    "frontend": {},
    "backend": {}
}