Start uploading reports to PipeRider Cloud
With a PipeRider Cloud account you can upload reports from PipeRider CLI and access the following features:
- Upload reports automatically
- Create workspaces to organize reports
- Share reports with team members or publicly
- Compare reports online
Reports can be configured to automatically upload each time PipeRider is ran, or can be uploaded individually (see below).
There are two ways to sign up for PipeRider Cloud, either by using PipeRider CLI, or via the website.
It is preferable to sign up via the CLI, as this will simultaneously create an account and enable you to configure your API token for report uploading.
To sign up for PipeRider Cloud using PipeRider CLI, follow the steps below.
piperider cloud signup.
- 3.Enter your email address.
- 4.Open your email account and find the 'welcome' email.
- 5.Click the 'Get API Token' button in the email.
- 6.Set your account password by filling out
Confirm New Password(leave
Current Passwordblank), and then click
- 7.Copy the API token.
- 8.Go back to the command line and paste the API token.
- 9.Your account is now created and you are logged in via PipeRider CLI
To sign up for PipeRider Cloud via the website navigate to the sign up page and fill out the sign up form.
If you have already created a PipeRider Cloud account and need to log in via the CLI, you should first obtain the API token from your account.
- 2.Copy the Token.
- 3.On the command line run
piperider cloud login.
- 4.Enter your email address.
- 5.Paste the API token.
If successful, your account details will be displayed in the output.
[?] API token: abc123
───────────────────────────── Login Successful ───────────────────────────────────
Email Username Full Name Storage Location Timezone
[email protected] Support PipeRider North America Asia/Taipei
[Config] Default project is set to 'workspace/default'
If you need to verify that your current PipeRider Cloud connection settings, run the following command from inside your project:
If correctly configured, you should see
Check cloud accounttest.
Check cloud account:
Run as user: [email protected]
User Name: Support
Full Name: PipeRider Support
Auto Upload: False
Default project: workspace-name/project-name
By default, Auto Upload is not configured, see below for instructions on how to enable automatically uploading reports.
Reports can either be uploaded on a per-report basis, or PipeRider can be configured to automatically upload all reports.
Reports can be uploaded on a per-run basis using the
piperider run --upload
Existing reports can also be uploaded with the following command:
piperider cloud upload-report
You will be prompted to select the reports you wish to upload from a list.
Upload settings are configured in your PipeRider profile, located at
To enable automatic uploading, add
auto_upload: trueto the
cloud_configsection of your PipeRider profile:
auto_uploadwill automatically upload reports, without prompt, as they are generated. Such as with