Documentation guides to setup locally
To set up the Sui Agent Kit on your local machine, you’ll need to clone the repository, install the required dependencies, configure environment variables, and build the project. Follow the steps below to begin.
npm -v
..env
file in the project’s root directory to securely store your environment variables. Ensure the file includes the following variables:OPENAI_API_KEY: Your OpenAI API key for generating images and interacting with OpenAI services.
RPC_URL: Your RPC_URL for Sui blockchain interactions.
SUI_PRIVATE_KEY: Your Sui wallet’s private key.
Note: Ensure that the .env
file is added to .gitignore
to prevent exposing sensitive information.
5. Build the Project
This will generate the compiled files in the dist/
directory.
6. Generate Documentation (Optional)
The documentation will be available in the docs/ directory.
Documentation guides to setup locally
To set up the Sui Agent Kit on your local machine, you’ll need to clone the repository, install the required dependencies, configure environment variables, and build the project. Follow the steps below to begin.
npm -v
..env
file in the project’s root directory to securely store your environment variables. Ensure the file includes the following variables:OPENAI_API_KEY: Your OpenAI API key for generating images and interacting with OpenAI services.
RPC_URL: Your RPC_URL for Sui blockchain interactions.
SUI_PRIVATE_KEY: Your Sui wallet’s private key.
Note: Ensure that the .env
file is added to .gitignore
to prevent exposing sensitive information.
5. Build the Project
This will generate the compiled files in the dist/
directory.
6. Generate Documentation (Optional)
The documentation will be available in the docs/ directory.