Nimbus

Appearance

Quickstart ​

To get started with Nimbus you need to install the @nimbus/core package and other relevant @nimbus packages based on your needs.

Dependencies ​

Nimbus tries to keep dependencies as low as possible, but there are some packages that are necessary to run Nimbus.

For type validations Nimbus relies on Zod.
And for logging the @std/log package is used.

Installation ​

Depending on your runtime you can install Nimbus with the following commands.

Deno ​

bash
deno add jsr:@nimbus/core npm:zod jsr:@std/log

NPM ​

bash
npm install zod
npx jsr add @nimbus/core @std/log

Bun ​

bash
bun add zod
bunx jsr add @nimbus/core @std/log

Create the first Command ​

To create the first command see the example below. You can find a full documentation about commands here.

typescript
import { Command } from "@nimbus/core";
import { z } from "zod";

export const GreetMeCommand = Command(
    z.literal("GREET_ME"),
    z.object({
        name: z.string(),
    }),
    z.object({
        allowedActions: z.array(z.string()),
    })
);
export type GreetMeCommand = z.infer<typeof GreetMeCommand>;