| title | description | id | hide_title | slug |
|---|---|---|---|---|
login |
Learn how to login to neosync via the neosync login command. |
login |
false |
/cli/login |
Learn how to login to neosync via the neosync login command.
The neosync login command is used to login to neosync through the CLI to generate an access token.
This can then be utilized with other commands to perform authenticated requests to Neosync API.
neosync loginRunning this command will open up a browser window and direct the user through the login flow that has been configured by the API.
If on success, an access token and (optionally) a refresh token will be saved to the filesystem in $NEOSYNC_CONFIG_DIR.
| Variable | Description | Is Required | Default Value |
|---|---|---|---|
| NEOSYNC_API_URL | The base url of the Neosync API. This can be overridden to connect to different Neosync API environments | false | http://localhost:8080 |
| NEOSYNC_API_KEY | The api key for Neosync API. | false | |
| LOGIN_HOST | The http server that is booted up running neosync login via an oauth flow |
false | 127.0.0.1 |
| LOGIN_REDIRECT_HOST | The redirect host that is sent alongside the oauth flow when running neosync login |
false | 127.0.0.1 |
| LOGIN_PORT | The port the http server runs on when running neosync login |
false | 4242 |