Skip to content

docs: add Linux CLI terminal installation instructions and clean up outdated steps #147

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.

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

Merged
merged 16 commits into from
May 12, 2025
Merged
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
fix: lint
  • Loading branch information
aryanjassal committed May 7, 2025
commit 4f8b075aed414416c8d5aa1503f9a624abd33f64
40 changes: 24 additions & 16 deletions docs/Getting-Started/polykey-cli/installation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Admonition from '@theme/Admonition';
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import
Admonition from '@theme/Admonition';

# Installation

Expand Down Expand Up @@ -46,34 +45,43 @@ libraries that Node.js requires.

#### Using the Polykey CLI via the terminal

If you prefer not to use a package manager or Docker, you can install Polykey directly via the terminal using a prebuilt binary.
If you prefer not to use a package manager or Docker, you can install Polykey
directly via the terminal using a prebuilt binary.

1. Download the executable from the [GitHub releases page](https://github.com/MatrixAI/Polykey-CLI/releases) and rename it to `polykey`.
1. Download the executable from the
[GitHub releases page](https://github.com/MatrixAI/Polykey-CLI/releases) and
rename it to `polykey`.

2. Make it executable:

```sh
chmod u+x ./polykey

3. Move it into a directory in your $PATH, or add the current directory to your $PATH temporarily:
* For ZSH:
```

echo 'export PATH=~/Downloads:$PATH' >> ~/.zshrc && source ~/.zshrc
3. Move it into a directory in your $PATH, or add the current directory to your
$PATH temporarily:

* For Bash:
echo 'export PATH=~/Downloads:$PATH' >> ~/.bashrc && source ~/.bashrc
- For ZSH:

4. Confirm the installation:
polykey --version
echo 'export PATH=~/Downloads:$PATH' >> ~/.zshrc && source ~/.zshrc

- For Bash: echo 'export PATH=~/Downloads:$PATH' >> ~/.bashrc && source
~/.bashrc

4. Confirm the installation: polykey --version

If it returns the version, you’re ready to use the CLI.

:::tip Important: Agent behavior
:::tip Important: Agent behavior

Once you start the Polykey agent, the terminal window will be fully occupied by the running agent process.
Once you start the Polykey agent, the terminal window will be fully occupied by
the running agent process.

To continue issuing Polykey commands (e.g., to create a vault), you must open a **new terminal window**.
If the system shuts down or the agent process stops, you’ll need to **restart the agent** before running any other commands.
To continue issuing Polykey commands (e.g., to create a vault), you must open a
**new terminal window**.
If the system shuts down or the agent process stops, you’ll need to **restart
the agent** before running any other commands.

:::

Expand Down
Loading