Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: document all preferences #302

Merged
merged 1 commit into from
Sep 21, 2023
Merged

chore: document all preferences #302

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,16 @@ token=$(gcloud auth print-access-token)
apigeecli orgs get -t $token #fetches the org details of the org set in preferences
```

The following preferences can be set:

| Flag | Description |
| -----------------------| ----------------------------------------------------- |
| `-g, --github string` | On premises Github URL |
| `-o, --org string` | Apigee organization name |
| `-p, --proxy string` | Use http proxy before contacting the control plane |
| `--nocheck` | Don't check for newer versions of cmd |


## Container download
The lastest container version for apigeecli can be downloaded via

Expand Down
2 changes: 1 addition & 1 deletion cmd/apis/ghcrtapis.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ var GhCreateCmd = &cobra.Command{
Use: "github",
Aliases: []string{"gh"},
Short: "Creates an API proxy from a GitHub repo",
Long: "Creates an API proxy from a GitHub repo",
Long: "Creates an API proxy from a GitHub repo. Check apigeecli prefs for GH on-prem options",
Args: func(cmd *cobra.Command, args []string) (err error) {
re := regexp.MustCompile(`(\w+)?\/apiproxy$`)
if ok := re.Match([]byte(ghPath)); !ok {
Expand Down
2 changes: 1 addition & 1 deletion cmd/sharedflows/ghcrtsf.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ var GhCreateCmd = &cobra.Command{
Use: "github",
Aliases: []string{"gh"},
Short: "Creates a sharedflow from a GitHub repo",
Long: "Creates a sharedflow from a GitHub repo",
Long: "Creates a sharedflow from a GitHub repo. Check apigeecli prefs for GH on-prem options",
Args: func(cmd *cobra.Command, args []string) (err error) {
re := regexp.MustCompile(`(\w+)?\/sharedflowbundle$`)
if ok := re.Match([]byte(ghPath)); !ok {
Expand Down