@clear-street/stuctl
v1.0.5
Published
Clear Street Studio's CLI
Downloads
19
Readme
Usage
The only prerequisite for using stuctl
is having nodejs v20.11.1
or higher installed.
Assuming you're running the right version node, run the following command to install stuctl
:
$ npm install -g @clear-street/stuctl
Most commands provided by stuctl
require authentication. To properly authenticate, you need to follow Clear Street Studio's OAuth2 flow:
If you don't have an OAuth2 credentials already, here are the steps:
- Sign into Clear Street Studio
- Navigate to
Settings -> Developer
- Create a new OAuth2 API credential
- Download your credentials to a secure location
Now, you can provide stuctl
the proper authentication using the login
command:
$ stuctl login /path/to/oauth2-creds.json
You can now successfully invoke other stuctl
commands, like buy
, sell
, etc.
Data
This app persists data, such as access tokens, for use between runs. This data is stored in a file named .sturc
. Values from the .sturc
file are injected as environment variables when stuctl
runs. The .sturc
file lives in ~/.sturc
on Linux-based systems, or %USERPROFILE%/.sturc
on Windows systems.
Since access tokens are stored in this file, it's important you keep this file safe and secure.
You can set the default account with the command:
$ stuctle set account <your-account>
You can set the default URL with the command:
$ stuctle set url <studio-api-url>
Which will store the arguments for you in the .sturc
file to avoid having to provide them through command-line arguments.
You can additionally manually add these values to your .sturc
:
ACCOUNT=<your-account>
This will default all commands that require an account to use <your-account>
.
URL=<studio-api-url>
This will point stuctl
to the provided Studio API URL.