CLI: add readme with install instructions #1599
Merged
+167
−4
Conversation
This file contains 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
svix-onelson
force-pushed
the
onelson/cli-build-with-dist
branch
from
c5094d5 to
66042cd
Compare
svix-onelson
force-pushed
the
onelson/cli-readme
branch
8 times, most recently
from
70ee772 to
411fe28
Compare
The text in this readme is based largely on the one from the old Go CLI. Some sections have been removed since support for the thing being mentioned was not carried forward (e.g. `--data-*` flags, import/export, and also piping json bodies in which apparently our new clap-based parser doesn't do). Installer instructions are limited to the initial set offered via #1593 Since the version number appears in the script-based installer URLs, `tools/bump_version.js` has been updated to also target this readme. More sections will be added to describe `homebrew`/`cargo` installation once available.
svix-onelson
force-pushed
the
onelson/cli-readme
branch
from
411fe28 to
280476b
Compare
tasn
approved these changes
Jan 2, 2025
tasn
previously approved these changes
Jan 2, 2025
tasn
approved these changes
Jan 2, 2025
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.
The text in this readme is based largely on the one from the old Go CLI.
Some sections have been removed since support for the thing being
mentioned was not carried forward (e.g.
--data-*flags, import/export, andalso piping json bodies in which apparently our new clap-based parser doesn't
do).
Installer instructions are limited to the initial set offered via
#1593
Since the version number appears in the script-based installer URLs,
tools/bump_version.jshas been updated to also target this readme.More sections will be added to describe
homebrew/cargoinstallationonce available.