|
1 | | -import Tabs from '@theme/Tabs'; |
2 | | -import TabItem from '@theme/TabItem'; |
3 | | -import Admonition from '@theme/Admonition'; |
| 1 | +import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import |
| 2 | +Admonition from '@theme/Admonition'; |
4 | 3 |
|
5 | 4 | # Installation |
6 | 5 |
|
@@ -46,34 +45,43 @@ libraries that Node.js requires. |
46 | 45 |
|
47 | 46 | #### Using the Polykey CLI via the terminal |
48 | 47 |
|
49 | | -If you prefer not to use a package manager or Docker, you can install Polykey directly via the terminal using a prebuilt binary. |
| 48 | +If you prefer not to use a package manager or Docker, you can install Polykey |
| 49 | +directly via the terminal using a prebuilt binary. |
50 | 50 |
|
51 | | -1. Download the executable from the [GitHub releases page](https://github.com/MatrixAI/Polykey-CLI/releases) and rename it to `polykey`. |
| 51 | +1. Download the executable from the |
| 52 | + [GitHub releases page](https://github.com/MatrixAI/Polykey-CLI/releases) and |
| 53 | + rename it to `polykey`. |
52 | 54 |
|
53 | 55 | 2. Make it executable: |
54 | 56 |
|
55 | 57 | ```sh |
56 | 58 | chmod u+x ./polykey |
57 | 59 |
|
58 | | -3. Move it into a directory in your $PATH, or add the current directory to your $PATH temporarily: |
59 | | -* For ZSH: |
| 60 | + ``` |
60 | 61 |
|
61 | | - echo 'export PATH=~/Downloads:$PATH' >> ~/.zshrc && source ~/.zshrc |
| 62 | +3. Move it into a directory in your $PATH, or add the current directory to your |
| 63 | + $PATH temporarily: |
62 | 64 |
|
63 | | -* For Bash: |
64 | | - echo 'export PATH=~/Downloads:$PATH' >> ~/.bashrc && source ~/.bashrc |
| 65 | +- For ZSH: |
65 | 66 |
|
66 | | -4. Confirm the installation: |
67 | | - polykey --version |
| 67 | +echo 'export PATH=~/Downloads:$PATH' >> ~/.zshrc && source ~/.zshrc |
| 68 | + |
| 69 | +- For Bash: echo 'export PATH=~/Downloads:$PATH' >> ~/.bashrc && source |
| 70 | + ~/.bashrc |
| 71 | + |
| 72 | +4. Confirm the installation: polykey --version |
68 | 73 |
|
69 | 74 | If it returns the version, you’re ready to use the CLI. |
70 | 75 |
|
71 | | - :::tip Important: Agent behavior |
| 76 | +:::tip Important: Agent behavior |
72 | 77 |
|
73 | | -Once you start the Polykey agent, the terminal window will be fully occupied by the running agent process. |
| 78 | +Once you start the Polykey agent, the terminal window will be fully occupied by |
| 79 | +the running agent process. |
74 | 80 |
|
75 | | -To continue issuing Polykey commands (e.g., to create a vault), you must open a **new terminal window**. |
76 | | -If the system shuts down or the agent process stops, you’ll need to **restart the agent** before running any other commands. |
| 81 | +To continue issuing Polykey commands (e.g., to create a vault), you must open a |
| 82 | +**new terminal window**. |
| 83 | +If the system shuts down or the agent process stops, you’ll need to **restart |
| 84 | +the agent** before running any other commands. |
77 | 85 |
|
78 | 86 | ::: |
79 | 87 |
|
|
0 commit comments