From 9cfe0f14c5583208d46ce3a710f10497cb6a64fa Mon Sep 17 00:00:00 2001 From: Ben Zarboni <99673202+bzarboni1@users.noreply.github.com> Date: Thu, 30 May 2024 17:22:51 -0400 Subject: [PATCH 1/4] Update README.md Updated the installation instructions with the correct links / steps Signed-off-by: Ben Zarboni <99673202+bzarboni1@users.noreply.github.com> --- README.md | 63 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 33 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index fd272cc..eace227 100644 --- a/README.md +++ b/README.md @@ -16,12 +16,6 @@ A command-line tool for the Github Foundations framework. - [Windows](#windows) - [From source](#from-source) - - - - - - ## Usage There are a few main tools provided by the Github Foundations CLI: @@ -112,53 +106,62 @@ Download the latest release from the [releases page](http:github.com/FociSolutio **ADM64** ``` -curl -LO "https://github.com/FociSolutions/github-foundations-cli/releases/download/$(curl -s https://api.github.com/repos/FociSolutions/github-foundations-cli/releases/latest | grep tag_name | cut -d '"' -f 4)/UPDATE_ME_github_foundations_linux_amd64" -chmod +x UPDATE_ME_github_foundations_linux_amd64 -sudo mv UPDATE_ME_github_foundations_linux_amd64 /usr/local/bin/gh_foundations +curl -LO https://github.com/FociSolutions/github-foundations-cli/releases/latest/download/github-foundations-cli_Linux_x86_64.tar.gz +tar -xzf github-foundations-cli_Linux_x86_64.tar.gz +chmod +x github-foundations-cli +sudo mv github-foundations-cli /usr/local/bin ``` **ARM64** ``` -curl -LO "https://github.com/FociSolutions/github-foundations-cli/releases/download/$(curl -s https://api.github.com/repos/FociSolutions/github-foundations-cli/releases/latest | grep tag_name | cut -d '"' -f 4)/UPDATE_ME_github_foundations_linux_arm64" -chmod +x UPDATE_ME_github_foundations_linux_arm64 -sudo mv UPDATE_ME_github_foundations_linux_arm64 /usr/local/bin/gh_foundations +curl -LO https://github.com/FociSolutions/github-foundations-cli/releases/latest/download/github-foundations-cli_Linux_arm64.tar.gz +tar -xzf github-foundations-cli_Linux_arm64.tar.gz +chmod +x github-foundations-cli +sudo mv github-foundations-cli /usr/local/bin ``` #### MacOS **ADM64** ``` -curl -LO "https://github.com/FociSolutions/github-foundations-cli/releases/download/$(curl -s https://api.github.com/repos/FociSolutions/github-foundations-cli/releases/latest | grep tag_name | cut -d '"' -f 4)/UPDATE_ME_github_foundations_darwin_amd64" -chmod +x UPDATE_ME_github_foundations_darwin_amd64 -sudo mv UPDATE_ME_github_foundations_darwin_amd64 /usr/local/bin/gh_foundations +curl -LO https://github.com/FociSolutions/github-foundations-cli/releases/latest/download/github-foundations-cli_Linux_x86_64.tar.gz +tar -xzf github-foundations-cli_Darwin_x86_64.tar.gz +chmod +x github-foundations-cli +sudo mv github-foundations-cli /usr/local/bin ``` **ARM64** ``` -curl -LO "https://github.com/FociSolutions/github-foundations-cli/releases/download/$(curl -s https://api.github.com/repos/FociSolutions/github-foundations-cli/releases/latest | grep tag_name | cut -d '"' -f 4)/UPDATE_ME_github_foundations_darwin_arm64" -chmod +x UPDATE_ME_github_foundations_darwin_arm64 -sudo mv UPDATE_ME_github_foundations_darwin_arm64 /usr/local/bin/gh_foundations +curl -LO https://github.com/FociSolutions/github-foundations-cli/releases/latest/download/github-foundations-cli_Linux_arm64.tar.gz +tar -xzf github-foundations-cli_Darwin_arm64.tar.gz +chmod +x github-foundations-cli +sudo mv github-foundations-cli /usr/local/bin ``` #### Windows +--- **i386** -``` -curl -LO "https://github.com/FociSolutions/github-foundations-cli/releases/download/$(curl -s https://api.github.com/repos/FociSolutions/github-foundations-cli/releases/latest | grep tag_name | cut -d '"' -f 4)/UPDATE_ME_github_foundations_windows_386.exe" -... -``` + +1. Download the [latest release here](https://github.com/FociSolutions/github-foundations-cli/releases/download/v0.0.5/github-foundations-cli_Windows_i386.zip) **ADM64** -``` -curl -LO "https://github.com/FociSolutions/github-foundations-cli/releases/download/$(curl -s https://api.github.com/repos/FociSolutions/github-foundations-cli/releases/latest | grep tag_name | cut -d '"' -f 4)/UPDATE_ME_github_foundations_windows_amd64.exe" -... -``` +1. Download the [latest release here](https://github.com/FociSolutions/github-foundations-cli/releases/download/v0.0.5/github-foundations-cli_Windows_i386.zip) **ARM64** -``` -curl -LO "https://github.com/FociSolutions/github-foundations-cli/releases/download/$(curl -s https://api.github.com/repos/FociSolutions/github-foundations-cli/releases/latest | grep tag_name | cut -d '"' -f 4)/UPDATE_ME_github_foundations_windows_arm64.exe" -... -``` +1. Download the [latest release here](https://github.com/FociSolutions/github-foundations-cli/releases/download/v0.0.5/github-foundations-cli_Windows_i386.zip) +--- + +2. Unzip the package +3. Place the `github-foundations-cli.exe` executable in a directory of your choice, for example: `%USERPROFILE%\gh-foundations` + +* **Add to Path (Optional):** +4. Right-click on "This PC" and select "Properties". +5. Click on "Advanced system settings". +6. Click on the "Environment Variables" button. +7. Under "System variables", find the "Path" variable and click "Edit". +8. Click "New" and add the following path: `%USERPROFILE%\gh-foundations` (replace with your chosen directory) +9. Click "OK" on all open windows to save the changes. ### From source 1. Run `git clone && cd gh-foundations-cli/` From 39c62cc7e803adc894fe5ee86e020970148534e5 Mon Sep 17 00:00:00 2001 From: Ben Zarboni <99673202+bzarboni1@users.noreply.github.com> Date: Thu, 30 May 2024 17:25:55 -0400 Subject: [PATCH 2/4] Update README.md Updated usage instructions Signed-off-by: Ben Zarboni <99673202+bzarboni1@users.noreply.github.com> --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index eace227..d358c5d 100644 --- a/README.md +++ b/README.md @@ -78,7 +78,7 @@ list various resources managed by the tool. ``` Usage: - gh_foundations list [ProjectDirectory] [options] + gh_foundations list [options] [ProjectsDirectory|OrganzationsDirectory] ``` @@ -86,7 +86,8 @@ Where `` is one of the following: - repos - orgs -`[ProjectDirectory]` is the path to the Terragrunt `Project` directory. +`[ProjectsDirectory]` is the path to the Terragrunt `Projects` directory when listing `repos`. +`[OrganzationsDirectory]` is the path to the Terragrunt `OrganzationsDirectory` directory when listing `orgs`. `[options]` is a list of options to filter the list of resources. The options are: - repos: From 3af3875fe18ba19ea38dfe3f008077928e0ea528 Mon Sep 17 00:00:00 2001 From: Ben Zarboni <99673202+bzarboni1@users.noreply.github.com> Date: Thu, 30 May 2024 17:27:35 -0400 Subject: [PATCH 3/4] Update README.md Formatting Signed-off-by: Ben Zarboni <99673202+bzarboni1@users.noreply.github.com> --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d358c5d..4f5c053 100644 --- a/README.md +++ b/README.md @@ -86,8 +86,8 @@ Where `` is one of the following: - repos - orgs -`[ProjectsDirectory]` is the path to the Terragrunt `Projects` directory when listing `repos`. -`[OrganzationsDirectory]` is the path to the Terragrunt `OrganzationsDirectory` directory when listing `orgs`. +- `[ProjectsDirectory]` is the path to the Terragrunt `Projects` directory when listing `repos`. +- `[OrganzationsDirectory]` is the path to the Terragrunt `OrganzationsDirectory` directory when listing `orgs`. `[options]` is a list of options to filter the list of resources. The options are: - repos: From a800f21b7256f980dfd06597772956c917e0ccdd Mon Sep 17 00:00:00 2001 From: Ben Zarboni <99673202+bzarboni1@users.noreply.github.com> Date: Thu, 30 May 2024 17:29:10 -0400 Subject: [PATCH 4/4] Update README.md Formatting Signed-off-by: Ben Zarboni <99673202+bzarboni1@users.noreply.github.com> --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4f5c053..a606f04 100644 --- a/README.md +++ b/README.md @@ -86,8 +86,10 @@ Where `` is one of the following: - repos - orgs -- `[ProjectsDirectory]` is the path to the Terragrunt `Projects` directory when listing `repos`. -- `[OrganzationsDirectory]` is the path to the Terragrunt `OrganzationsDirectory` directory when listing `orgs`. + +`[ProjectsDirectory]` is the path to the Terragrunt `Projects` directory when listing `repos`. + +`[OrganzationsDirectory]` is the path to the Terragrunt `OrganzationsDirectory` directory when listing `orgs`. `[options]` is a list of options to filter the list of resources. The options are: - repos: