DX-2866: add upstash start-redis command - #15
Open
CahidArda wants to merge 2 commits into
Open
Conversation
Adds an unauthenticated top-level command that POSTs to https://upstash.com/start-redis and prints the returned markdown (credentials + quickstart). `--id` re-fetches an earlier database via the Idempotency-Key header. Also surfaces it from the README and from `upstash redis create --help`.
There was a problem hiding this comment.
Pull request overview
Adds a new top-level upstash start-redis command that provisions a temporary Redis instance without requiring prior authentication, and surfaces the feature in help text and README so users discover it quickly.
Changes:
- Introduces
start-rediscommand that POSTs tohttps://upstash.com/start-redis, optionally sendingIdempotency-Keyvia--id, and prints the returned markdown. - Registers the new command in the CLI entrypoint.
- Adds unit tests plus README / help-text updates pointing users to the new workflow.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
src/commands/start-redis.ts |
New command implementation for unauthenticated temporary Redis provisioning and markdown output. |
src/cli.ts |
Wires registerStartRedis into the top-level CLI. |
src/commands/redis/create.ts |
Updates redis create help text to point users to start-redis for the no-account flow. |
README.md |
Documents the new no-account path and updates “Quick examples” to include start-redis. |
tests/unit/start-redis.test.ts |
Adds unit coverage for request behavior, --id header handling, and error propagation. |
Comments suppressed due to low confidence (1)
README.md:42
- “All output is JSON” isn’t accurate:
login/logoutprint plain text, andstart-redisprints markdown. Since this is user-facing behavior, the README should list all exceptions to avoid breaking automation assumptions.
All output is JSON, so you can pipe to `jq` (the one exception is `start-redis`, which prints markdown). Use `--dry-run` to preview destructive commands.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Wrap fetch/network failures in plainError so this command's errors are plain text like its markdown output, not the JSON error path. - Drop markdown backticks from the 'redis create' description; commander help is plain text. - Correct the README claims about which commands are unauthenticated and which print JSON — login/logout are also unauthenticated and print plain text.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds an unauthenticated top-level command that POSTs to https://upstash.com/start-redis and prints the returned markdown (credentials + quickstart).
--idre-fetches an earlier database via the Idempotency-Key header.Also surfaces it from the README and from
upstash redis create --help.