stellarcli

README

stellar

The stellar command line interface (CLI) is an experimental tool primarily used by the StellarStation development team to perform internal end-to-end tests when developing the StellarStation API.

For best results, it is strongly recommended that users develop their own client interfaces which communicate directly with the defined StellarStation API, rather than through the stellar CLI tool.

The stellar CLI tool is offered with an Open Source license with the purpose of sharing knowledge about the StellarStation platform. Anyone is welcome to use this tool for their own testing purposes, or to use it as an example of how a client can communicate with the StellarStation API.

Since this tool is in the Alpha stages of development, support is only provided on a "best effort" basis.

Download

Precompiled binaries of the app can be found on the releases page.

We attempt to give detailed information on using the app in the tool's help message.

$ stellar -h

If you see anything is unclear, feel free to file an issue or send a pull request.

Authentication

The utility can be authenticated using a StellarStation API key. If you don't have one yet, issue a key at your account page on StellarStation Console. The key can be activated using

$ stellar auth activate-api-key path/to/stellarstation-private-key.json

All commands after that will be authenticated using that key.

Documentation

Documentation page describes more detail of stellar commands.

Testing

When testing the CLI against the StellarStation API Fakeserver, you may change the server endpoint by setting the STELLARSTATION_API_URL environment variable, eg:

$ export STELLARSTATION_API_URL=localhost:8080

Developing

The utility requires either Java or Go 1.13. When using Java with Gradle, Go is automatically downloaded and does not need to be installed.

# Java users
$ ./gradlew build

# Go users
$ go build

The Gradle build using Java is our canonical build and is recommended to make sure results are the same as continuous integration.