CLI Commands

To add a cli command to your app, you'll need to add a run method to your app's default export.

// File: ~/smallweb/custom-command/main.ts
export default {
    run(args: string[]) {
        console.log("Hello world");
    }
}

Use smallweb run to execute the command:

$ smallweb run custom-command
Hello world

Accessing stdin

You can access stdin by using the optional input argument of the run method.

// File: ~/smallweb/custom-command/main.ts
export default {
    run(_args: string[], input: ReadableStream) {
        console.log("You just piped:");
        console.log(input);
    }
}

Using a cli framework

I personally recommend using gunshi to build complex cli commands.

import { cli } from 'npm:[email protected]'

export default {
    async run(args: string[]) {
        await cli(args, {
            options: {
                name: {
                    type: "string",
                    default: "world",
                }
            },
            run: (ctx) => {
                console.log(`Hello ${ctx.values.name}!`)
            }
        })
    }
}