docs: improve quickstart

npi-ai · Apr 25, 2024 · 708a7be · 708a7be
1 parent 7d8eaab
commit 708a7be
Show file tree

Hide file tree

Showing 5 changed files with 59 additions and 27 deletions.
diff --git a/README.md b/README.md
@@ -41,26 +41,24 @@ Verify the installation by running `npi version`. If you see the output similar
 }
 ```
 
-#### Setting Up NPi Server with Docker
+#### Setting Up NPi Server
 
 Replace `YOUR_OAI_KEY` with your actual OpenAI API Key, then execute:
 
 ```sh
-docker run -d --name npi \
+docker run -d --name npi --pull always \
     -p 9140:9140 \
     -p 9141:9141 \
-    -e OPENAI_API_KEY=YOUR_OAI_KEY \
-    npiai/npi:v0.0.1
+    -e OPENAI_API_KEY=YOUR_OAI_KEY npiai/npi
 ```
 
 if you run on macOS, please use:
 
 ```sh
-docker run -d --name npi \
+docker run -d --name npi --pull always \
    -p 9140:9140 \
    -p 9141:9141 \
-   -e OPENAI_API_KEY=YOUR_OAI_KEY \
-   npiai/npi-mac:v0.0.1
+   -e OPENAI_API_KEY=YOUR_OAI_KEY npiai/npi-mac
 ```
 
 Confirm server connectivity by running `npi connect test`. If you receive a `NPi Server is operational!` message, the
@@ -72,11 +70,13 @@ to [NPi GitHub Repository](https://github.com/npi-ai/npi/issues/new).
 
 #### Authorize NPi to access your GitHub account
 
-Generate a new token via [GitHub Tokens Page](https://github.com/settings/tokens) for NPi, and authorize NPi's access to
-your GitHub account with the following command. You may need to grant the `repo` scope so that NPi can access
+Generate a new token via [GitHub Tokens Page](https://github.com/settings/tokens) for NPi, you may need to grant the `repo` scope so that NPi can access
 repositories on behalf of
 you. ([Read more about scopes](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps))
 
+![img.png](docs/assets/github-token-grant-repo.png)
+
+and authorize NPi's access to your GitHub account with the following command.
 ```sh
 npi auth github --access-token YOUR_GITHUB_ACCESS_TOKEN
 ```

diff --git a/docs/assets/github-token-grant-repo.png b/docs/assets/github-token-grant-repo.png
diff --git a/docs/pages/cli.mdx b/docs/pages/cli.mdx
@@ -4,3 +4,4 @@ import { Todo } from '@components/todo';
 
 # Command line tool
 
+This content is rolling out in the next few days. Stay back later👀.
diff --git a/docs/pages/index.mdx b/docs/pages/index.mdx
@@ -15,17 +15,31 @@ NPi (**N**atural-language **P**rogramming **I**nterface), pronounced as **"N π"
 
     ### Installation
 
-    <Tabs items={['arm64','amd64']}>
+    <Tabs items={['macOS/arm64','macOS/amd64','linux/arm64','linux/amd64']}>
         <Tabs.Tab >
             ```sh
-            curl -O https://s.npi.ai/cli/v0.0.1/arm64/npi
+            curl -O https://s.npi.ai/cli/v0.0.1/darwin/arm64/npi
             chmod +x npi
             sudo mv npi /usr/local/bin
             ```
         </Tabs.Tab>
         <Tabs.Tab >
             ```sh
-            curl -O https://s.npi.ai/cli/v0.0.1/amd64/npi
+            curl -O https://s.npi.ai/cli/v0.0.1/darwin/amd64/npi
+            chmod +x npi
+            sudo mv npi /usr/local/bin
+            ```
+        </Tabs.Tab>
+        <Tabs.Tab >
+            ```sh
+            curl -O https://s.npi.ai/cli/v0.0.1/linux/amd64/npi
+            chmod +x npi
+            sudo mv npi /usr/local/bin
+            ```
+        </Tabs.Tab>
+        <Tabs.Tab >
+            ```sh
+            curl -O https://s.npi.ai/cli/v0.0.1/linux/amd64/npi
             chmod +x npi
             sudo mv npi /usr/local/bin
             ```
@@ -36,30 +50,45 @@ NPi (**N**atural-language **P**rogramming **I**nterface), pronounced as **"N π"
 
     ```json
     {
-        "BuildDate": "2024-04-23_02:23:50-0700",
-        "GitCommit": "934739f",
+        "BuildDate": "2024-04-25_10:15:33-0500",
+        "GitCommit": "5ae9953",
         "Platform": "darwin/arm64",
-        "Version": "v0.0.0"
+        "Version": "v0.0.1"
     }
     ```
 
-### Setting Up NPi Server with Docker
+### Setting Up NPi Server
+
+Replace `YOUR_OAI_KEY` with your actual OpenAI API Key, then execute:
+
+<Tabs items={['macOS', 'linux']}>
+    <Tabs.Tab >
+        ```sh
+        docker run -d --name npi --pull always \
+        -p 9140:9140 \
+        -p 9141:9141 \
+        -e OPENAI_API_KEY=YOUR_OAI_KEY npiai/npi-mac:latest
+        ```
+    </Tabs.Tab>
+    <Tabs.Tab >
+        ```sh
+            docker run -d --name npi --pull always \
+            -p 9140:9140 \
+            -p 9141:9141 \
+            -e OPENAI_API_KEY=YOUR_OAI_KEY npiai/npi:latest
+        ```
+    </Tabs.Tab>
+</Tabs>
 
-Replace `{YOUR_OAI_KEY}` with your actual OpenAI API Key, then execute:
-
-```sh
-docker run -d --name npi \
-    -p 9140:9140 \
-    -p 9141:9141 \
-    -e OPENAI_API_KEY={YOUR_OAI_KEY} \
-    npiai/npi
-```
 
 Confirm server connectivity by running `npi connect test`. If you receive a `server connected` message, the setup is successful. Otherwise, consult the logs with `docker logs npi` and report issues to [NPi GitHub Repository](https://github.com/npi-ai/npi/issues/new).
 
 ### Authorize NPi to access your GitHub account
 
-Generate a new token via [GitHub Tokens Page](https://github.com/settings/tokens) for NPi, and authorize NPi's access to your GitHub account with the following command. You may need to grant the `repo` scope so that NPi can access repositories on behalf of you. ([Read more about scopes](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps))
+Generate a new token via [GitHub Tokens Page](https://github.com/settings/tokens) for NPi, you may need to grant the `repo` scope so that NPi can access repositories on behalf of you. ([Read more about scopes](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps))
+![grant-repo-scope](../assets/github-token-grant-repo.png)
+
+and authorize NPi's access to your GitHub account with the following command.
 
 ```sh
 npi auth github --access-token YOUR_GITHUB_ACCESS_TOKEN

diff --git a/docs/pages/python.mdx b/docs/pages/python.mdx
@@ -2,4 +2,6 @@ import { Todo } from '@components/todo';
 
 <Todo />
 
-# Python SDK Reference
+# Python SDK Reference
+
+This content is rolling out in the next few days. Stay back later👀.