2

GitHub - npi-ai/npi: Tool use APIs platform for AI Agent

 2 weeks ago
source link: https://github.com/npi-ai/npi
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.

Repository files navigation

Warning

NPi is currently under active development and the APIs are subject to change in the future release. It is recommended to use the command line tool to try it out.

NPi is an open-source platform providing Tool-use APIs to empower AI agents with the ability to take action in virtual world!

👀 NPi Example: Highly recommended to check this first - See what you can build with NPi.

🔥 Introducing NPi: Why we build NPi?

📚 NPi Documentation: How to use NPi?

📢 Join our community on Discord: Let's build NPi together 👻 !

Quickstart

Installation

Command Line Tool

Download the binary from the following links.

# For darwin/arm64
curl -O https://s.npi.ai/cli/latest/darwin/arm64/npi

# For darwin/amd64
curl -O https://s.npi.ai/cli/latest/darwin/amd64/npi

# For linux/arm64
curl -O https://s.npi.ai/cli/latest/linux/arm64/npi

# For linux/amd64
curl -O https://s.npi.ai/cli/latest/linux/amd64/npi

Then move it to /usr/local/bin or any other directory in your PATH:

chmod +x npi
sudo mv npi /usr/local/bin

Verify the installation by running npi version. If you see the output similar to the following, you are all set:

{
  "BuildDate": "2024-04-23_02:23:50-0700",
  "GitCommit": "934739f",
  "Platform": "darwin/arm64",
  "Version": "v0.0.1"
}

Setting Up NPi Server

If Docker is not yet installed on your system, refer to the Docker Installation Guide for setup instructions.

Replace YOUR_OAI_KEY with your actual OpenAI API Key, then execute:

docker run -d --name npi --pull always \
    -p 9140:9140 \
    -p 9141:9141 \
    -e OPENAI_API_KEY=YOUR_OAI_KEY npiai/npi

For macOS users, use this command instead:

docker run -d --name npi --pull always \
   -p 9140:9140 \
   -p 9141:9141 \
   -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 setup is successful. Otherwise, consult the logs with docker logs npi and report issues to NPi GitHub Repository.

Try the GitHub App

Authorize NPi to access your GitHub account

Generate a new token via GitHub Tokens Page for NPi, you may need to grant the repo scope so that NPi can access repositories on behalf of you. (Read more about scopes)

img.png

Then, authorize NPi's access to your GitHub account with the following command:

npi auth github --access-token YOUR_GITHUB_ACCESS_TOKEN

Support the NPi Repository

Easily star and fork the NPi Repository using:

npi app github "Star, fork, and leave a supportive message in issue #27 of npi-ai/npi"

Clean up

  1. Stop and remove the NPi container: 
    docker stop npi
docker rm npi
  2. Revoke your GitHub access token by revisiting: GitHub Tokens Page.

Python SDK

NPI Python SDK

Multi-app Agent Examples

More: https://www.npi.ai/docs/examples

Roadmap

https://www.npi.ai/docs/roadmap

License

BSL v1.1


report

Recommend

About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK