Star CLI

Introduction

The star command line interface (CLI) handles tasks in a database. This page covers the most important commands. The rest of the commands can be found with star --help or star --helpextended.

Starcounter Version

The version of the current Starcounter installation is displayed with star --version or the shorthand star -v.

> star --version
Version=2.3.1.7018

Starting Apps

Apps are started with star [app] by specifying the path to the exe file. For example:

~\Apps\HelloWorld> star .\src\HelloWorld\bin\Debug\HelloWorld

Set Resource Directory

When starting an app, Starcounter will fail to find the application resource directory (wwwroot) if the current working directory is not the root of the project or the same directory as the resource directory. This will, for apps that use the Starcounter web stack presented in Blendable Web Apps, throw, ArgumentOutOfRangeException when opening the app.

To solve this, specify the resource directory with the --resourcedir option:

~\Apps\HelloWorld\src\HelloWorld\bin\Debug> star --resourcedir=../../wwwroot HelloWorld
HelloWorld -> default (started, default port 8080, admin 8181)

Read more about this on the page Static File Server.

Specify Database

By default, apps are started in the default database. To start apps in another database, use the --database option:

> staradmin new db myDatabase
Created (Name=myDatabase)
> star --database=myDatabase HelloWorld
HelloWorld -> mydatabase (started, default port 8080, admin 8181)

The shorthand notation is -d: star -d=myDatabase HelloWorld.

Change App Name

To start an app with another name than the existing one, use the --name option:

> star --name=HelloUniverse HelloWorld
HelloUniverse -> default (started, default port 8080, admin 8181)

Stopping Apps

Apps are stopped with the --stop option:

> star HelloWorld
HelloWorld -> default (started, default port 8080, admin 8181)
> star --stop HelloWorld
HelloWorld <- default (stopped)

Read Starting and Stopping Apps for more information.