Skip to Content

Core Library

Terminal
npm install @agentica/core @samchon/openapi typia npx typia setup

To install @agentica/core, you also have to install @samchon/openapi and typia.

@samchon/openapi is an OpenAPI specification library which can convert Swagger/OpenAPI document to LLM function calling schema. And typia is a transformer (compiler) library which can compose LLM function calling schema from a TypeScript class type.

By the way, as typia is a transformer library analyzing TypeScript source code in the compilation level, it needs additional setup command npx typia setup.

If youโ€™re not using non-standard TypeScript compiler (not tsc) or developing the agent in the frontend environment, you have to setup @typia/unplugin following its guide.

WebSocket Protocol

NodeJS Server

Terminal
npm install @agentica/core @samchon/openapi typia npm install @agentica/rpc tgrid npx typia setup

When developing #WebSocket server in NodeJS environment, you need to install tgrid and @agentica/rpc packages additionally.

tgrid is an RPC (Remote Procedure Call) framework supporting websocket protocol, and @agentica/rpc is a wrapper library of @agentica/core following the RPC paradigm of the tgrid.

NestJS Server

Terminal
npm install @agentica/core @samchon/openapi npm install @nestjs/common @nestjs/core @nestjs/platform-express npm install @agentica/rpc tgrid npm install -D nestia npx nestia setup

If you want to develop #WebSocket server in NestJS framework, you can do it with nestia.

Install @agentica/rpc, tgrid and NestJS packages first.

And then setup nestia with npx nestia setup command. It will setup every required packages for the WebSocket server in NestJS environment.

Client Application

Terminal
npm install @agentica/rpc tgrid

Client application does not require many packages.

Just install @agentica/rpc and tgrid packages.

Standalone Application

Terminal
npm install @agentica/core @samchon/openapi typia npx typia setup npm install -D @typia/unplugin

If you want to develop a standalone application which does everything in the frontend environment without any backend server interaction, you need to install above additional packages.

At first, @samchon/openapi is an OpenAPI specification library which can convert Swagger/OpenAPI document to LLM function calling schema. And typia is a transformer (compiler) library which can compose LLM function calling schema from a TypeScript class type.

By the way, as typia is a transformer library analyzing TypeScript source code in the compilation level, it needs additional setup command npx typia setup.

Also, as frontend environment tends to use non-standard TypeScript compiler (not tsc) like Vite, you have to setup @typia/unplugin package additionally following its setup guide document.

Warning

Standalone application, it must be not for production, but only for the testing environment.

If you distribute the standalone to the production, your LLM API key would be exposed to the public.

Last updated on