checkly / checkly/checkly-cli

feat: add a "download" or "results" sub command for retrieving check results

Open
#988 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
96
Forks
25
Avg merge
14h 14m
Merged PRs (30d)
38

Description

What problem does this feature solve?

As a customer/user of the CLI, I want to be able to download check results as well, w/o the need of tinkering together API requests. In a perfect world I'd be able to provide some filters (like tags, check type, success state, check id) for retrieving results.

How would you implement this feature?

I'd use the public API for data gathering and filtering where possible, otherwise use client side filtering.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the CLI command registration and the public API client used for check data. Define the command shape, supported filters, and result format before implementation. Done means users can retrieve check results without manual API requests and the behavior is covered by CLI tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.