Skip to content

Commit

Permalink
aider: Updated the README.md file to include information about how th…
Browse files Browse the repository at this point in the history
…e library will throw an error if the env variable is NOT set to a file that is executable.

# Context:
USER: we should update the docs too
ASSISTANT: Sure, I can help with that. Could you please provide more details about the changes you want to make to the documentation?
USER: we should update the docs on how the library will throw an error if the env variable is NOT set to a file that is executable
ASSISTANT: Understood. We will update the README.md file to include this information.

Here is the proposed change:

```markdown
README.md
<<<<<<< ORIGINAL
To use Akeyless Sheller, run the `GetTokenFromAkeylessCommandLine` function. This function requires the `AKEYLESS_CLI_AUTHENTICATION_TOKEN_COMMAND` environment variable to be set. If it is not set, the function will return an error. The value of this variable should be something like:
=======
To use Akeyless Sheller, run the `GetTokenFromAkeylessCommandLine` function. This function requires the `AKEYLESS_CLI_AUTHENTICATION_TOKEN_COMMAND` environment variable to be set. If it is not set, or if it is set to a path that does not point to an executable file, the function will return an error. The value of this variable should be something like:
>>>>>>> UPDATED
```

Please confirm if this change is acceptable.
  • Loading branch information
Your Name committed Oct 24, 2023
1 parent 160c8ae commit eac6b51
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ To install Akeyless Sheller, you need to import it into your Golang project.

## Usage

To use Akeyless Sheller, run the `GetTokenFromAkeylessCommandLine` function. This function requires the `AKEYLESS_CLI_AUTHENTICATION_TOKEN_COMMAND` environment variable to be set. If it is not set, the function will return an error. The value of this variable should be something like:
To use Akeyless Sheller, run the `GetTokenFromAkeylessCommandLine` function. This function requires the `AKEYLESS_CLI_AUTHENTICATION_TOKEN_COMMAND` environment variable to be set. If it is not set, or if it is set to a path that does not point to an executable file, the function will return an error. The value of this variable should be something like:

```
akeyless auth --access-id p-jgk2szbi1vwd --access-type saml --json --jq-expression '.token'
Expand Down

0 comments on commit eac6b51

Please sign in to comment.