Skip to main content

Troubleshooting

Architecture

The Meroxa CLI is an open source command line tool written in Go using the Cobra CLI Framework.

Troubleshooting

Upgrade the CLI Version

If you're having any issues with the CLI, make sure that you're on the latest version. Depending on how you installed the Meroxa CLI will dictate how you need to upgrade.

Homebrew (MacOS/Linux)

If you've followed the installation instructions, upgrading will only require issuing the upgrade command in Homebrew:

brew upgrade meroxa

Binary Installations (Cross Platform)

The recommendation is to follow the same instructions found in the CLI installation guide using the latest binary from the CLI releases.

Debugging

If you've confirmed that you have the latest version of the Meroxa CLI on your computer, the next step is to set up debugging. Debugging can be done one of two ways, either using a flag on a per command basis or setting an environment variable.

Most commands in the CLI allow the use of debug. If you wanted to see what the Meroxa CLI is doing when a command is issued, you can use the flag like so:

$ meroxa whoami --debug
GET /v1/users/me HTTP/1.1
Host: api.meroxa.io
User-Agent: Meroxa CLI 0.9.0
Accept: application/json
Authorization: Bearer adsf...asdf
Content-Type: application/json
Accept-Encoding: gzip

HTTP/2.0 200 OK
Content-Length: 183
Content-Type: application/json; charset=utf-8
Date: Wed, 26 May 2021 23:23:24 GMT
Meroxa-Request-Id: asdfas-asdf-asdf-asfd-asdf-
Vary: Origin

{"uuid":"adsf-sadf-asdf","email":"rimas@example.com","given_name":"Rimas","family_name":"Silkaitis","email_verified":true,"last_login":"1999-12-31"}
rimas@example.com

If you need to debug a set of command interactions, setting the environment variable MEROXA_DEBUG is preferred.

$ export MEROXA_DEBUG=true
$ meroxa whoami
GET /v1/users/me HTTP/1.1
Host: api.meroxa.io
User-Agent: Meroxa CLI 0.9.0
Accept: application/json
Authorization: Bearer adsf...asdf
Content-Type: application/json
Accept-Encoding: gzip

HTTP/2.0 200 OK
Content-Length: 183
Content-Type: application/json; charset=utf-8
Date: Wed, 26 May 2021 23:23:24 GMT
Meroxa-Request-Id: asdfas-asdf-asdf-asfd-asdf-
Vary: Origin

{"uuid":"adsf-sadf-asdf","email":"rimas@example.com","given_name":"Rimas","family_name":"Silkaitis","email_verified":true,"last_login":"1999-12-31"}
rimas@example.com

If you're unable to resolve the error with the extra debug information, please contact Meroxa Support at support@meroxa.io for more assistance.

CLI Versioning Guidance

The Meroxa CLI follows Semantic Versioning. For any breaking user experience changes or when we make considerable changes to our API, the major version will be updated. In situations where new functionality is added the minor version will be updated. Bug fixes will be point releases.