Adding cli commands to your app

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

Using a cli framework

Commander.js is a popular cli framework for Node.js.

You can easily wire it to smallweb:

import { program } from '@commander-js/extra-typings';

export default {
    run(args: string[]) {
        program.action(() => {
            console.log("Hello world");
        });

        await program.parseAsync(args, { from: "user" });
    }
}

See the Commander.js documentation for more information.

If you want to open urls in the user's browser, you can checkout the @smallweb/open package.