Skip to content

Commit a74eae6

Browse files
xrissoulaaryanjassal
authored andcommitted
docs: update installation and env variable docs for Polykey CLI refresh
1 parent 29818c1 commit a74eae6

File tree

2 files changed

+13
-4
lines changed

2 files changed

+13
-4
lines changed

docs/Getting-Started/polykey-cli/installation.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ Installing the CLI can be done in different ways depending on your operating
66
environment.
77

88
:::info
9+
## Polykey Core Overview
910

11+
The Polykey CLI and core primarily use TypeScript for service logic, domain business operations, and persistence layers. While the main codebase is in TypeScript, some supporting libraries incorporate native C++ or Rust for platform‐specific functionality. This approach combines cross‐platform convenience with native performance optimizations.
1012
Polykey-CLI has only been tested on Linux and macOS. We are working on
1113
supporting other platforms. There's minor teething problems when it comes
1214
supporting other platforms. Help us by reporting any issues with the CLI tool in
@@ -441,7 +443,7 @@ The CLI is published as
441443
Install it with:
442444
443445
```sh
444-
npm install -g polykey-cli
446+
npm install polykey
445447
```
446448
447449
This will install the Polykey-CLI into the path pointed to by the command

docs/Getting-Started/polykey-cli/using-environment-variables.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,13 +59,19 @@ application, you can output them in different formats.
5959
#### Unix-like Systems Example
6060

6161
```bash
62-
polykey secrets env --env-format unix --env Weather-Ops:API_KEY
62+
olykey secrets env --env-format unix --env MyVault:API_KEY
63+
64+
API_KEY=someRandomValue123
6365
```
6466

6567
#### JSON Format Example
6668

6769
```bash
68-
polykey secrets env --env-format json --env Weather-Ops:API_KEY
70+
polykey secrets env --env-format json --env MyVault:API_KEY
71+
72+
{
73+
"API_KEY": "someRandomValue123"
74+
}
6975
```
7076

7177
These commands display the environment variables in the console, useful for
@@ -99,7 +105,8 @@ secrets.
99105
#### AWS CLI Integration Example
100106

101107
```bash
102-
polykey secrets env --env AWS-Creds:AWS_ACCESS_KEY_ID,AWS-Creds:AWS_SECRET_ACCESS_KEY -- aws s3 ls
108+
polykey secrets env \
109+
$ polykey secrets env aws-creds:AWS_ACCESS_KEY_ID aws-creds:AWS_SECRET_ACCESS_KEY -- aws s3 ls
103110
```
104111

105112
This securely passes AWS credentials to the AWS CLI.

0 commit comments

Comments
 (0)