The stellar
command line interface (CLI) is an experimental tool. Support is provided on a "best effort" basis. It is strongly recommended that users develop their own client-side software to interface with the StellarStation API.
See the documentation for more details about commands in the latest version.
In the CLI itself, execute stellar --help
to see more details about commands available your installed version.
Precompiled binaries of the app can be found on the releases page.
Remember to extract the stellar
executable, place the executable in a good location, give your user the correct file permissions to execute stellar
, and optionally make sure that location is on the system path.
Decide which service endpoint you want to use. As of writing this, there are two service endpoints available to users:
- Test Environment:
api.qa.stellarstation.com:443
- Production Environment:
api.stellarstation.com:443
We will use the Test Environment for the purpose of this walkthrough.
Create an environment variable for your machine. This depends on your operating system and shell.
Linux
We will use Bash shell for the purpose of this walkthrough.
- Open ~/.bashrc
- Add
export STELLARSTATION_API_URL="api.qa.stellarstation.com:443"
to the end of the file. - Save and close the file.
- In the terminal, execute
source ~/.bashrc
Windows
It will look something like this procedure.
- Search
Environment Variables
in the Windows search bar and open theEnvironment Variables
manager. - Create a new environment variable with the name
STELLARSTATION_API_URL
and the valueapi.qa.stellarstation.com:443
. - Log out and log back in.
You will need an API key to fully use the CLI. This walkthrough assumes you have created an account on the appropriate server and know how to generate an API key through the StellarStation Console. As of writing this, there are two possible StellarStation Consoles available for users to log in to:
- Test Environment:
www.qa.stellarstation.com
- Production Environment:
www.stellarstation.com
Generate a private API key, download it, and place it somewhere safe.
IMPORTANT: Do not share this private key with anyone.
Execute stellar auth activate-api-key path/to/key.json
.
Now that you have completed authentication, we can update the TLE. This walkthrough assumes an Infostellar support engineer has configured a test ground station for your account below 51 degrees latitude.
Execute stellar satellite add-tle [STELLARSTATION SATELLITE ID HERE] "[TLE LINE 1]" "[TLE LINE 2]"
. Try the Space Station as a good temporary TLE for now.
Check that the TLE propagated to StellarStation.
Execute stellar satellite get-tle [STELLARSTATION SATELLITE ID HERE]
. The returned TLE should match the one you provided above.
WARNING: add-tle
sets the TLE updater in StellarStation to "Manual" mode - meaning that StellarStation will not automatically update the TLE. To set up automatic TLE updates please contact an Infostellar support engineer.
We can see a list of available passes now that the TLE is set.
Execute stellar satellite list-passes [STELLARSTATION SATELLITE ID HERE] --verbose
.
This will print out a huge list of passes (and corresponding reservation tokens for later use).
We can make a reservation now that we have the list of passes. Try reserving the last available pass in the list using it's reservationToken
.
Execute stellar satellite reserve-pass [reservationToken]
.
We can get a list of plans as well.
Execute stellar satellite list-plans [STELLARSTATION SATELLITE ID HERE]
.
We can cancel the plan above now that we have finished this walkthrough. You'll need the Plan ID from the reserved plan list.
Execute stellar satellite cancel-plan [PLAN ID]
.
Infostellar uses the 2nd-latest Go version to reduce security risk and release issues.
Infostellar uses golangci-lint for linting/static analysis rules.
Infostellar uses Go Releaser.
The stellar
CLI tool is offered with an Open Source license. Anyone is welcome to use this tool for testing, experimentation, etc.
If you experience trouble with the tool, please open a new Issue or contact an Infostellar support engineer.
If you want to contribute, feel free to comment on Issues or open a Pull Request.
This is most likely due to your locale and encoding, particularly with regard to Chinese, Japanese, and Korean (for example, zh_CN.UTF-8
or ja_JP.UTF-8
). The most direct way to fix this is to set RUNEWIDTH_EASTASIAN=0
in your environment. For more details see charmbracelet/lipgloss#40.