iniquity

A re-imagining of the iconic BBS software.

View on GitHub

Module: Term

Iniquity Term

Summary

Built-in terminal client to connect to an Iniquity BBS.

Example

Invoking via the shell

iq term
iq term localhost --port 2323

Table of contents

Variables

Functions

Variables

command

Const command: "term [host]"

Defined in

cli/src/commands/term.ts:44


default

Const default: yargs.CommandModule

Defined in

cli/src/commands/term.ts:97


describe

Const describe: "Connect to an Iniquity BBS with the built-in terminal client."

Defined in

cli/src/commands/term.ts:45

Functions

builder

builder(yargs): Argv<{ host: string } & { port: number }>

Parameters

Name Type
yargs Argv<{}>

Returns

Argv<{ host: string } & { port: number }>

Defined in

cli/src/commands/term.ts:47


handler

handler(argv): void

Parameters

Name Type
argv Object

Returns

void

Defined in

cli/src/commands/term.ts:61