Skip to content

quickstart.md

Latest commit

 

History

History
93 lines (71 loc) · 2.42 KB

quickstart.md

File metadata and controls

93 lines (71 loc) · 2.42 KB
Raw

Quick Start

This walks the same ground as the top-level README in more detail, then points you to what to read next. If you've already run the README's example, skip to Next steps.

Install

Requires Bun 1.3 or later.

mkdir my-cli && cd my-cli
bun init -y
bun add concise-ti

Your first command

concise-ti discovers commands from a commands/ directory next to your entrypoint - no manifest to write by hand for this to work.

Create commands/hello.ts:

import { command } from 'concise-ti'

export default command({
  meta: { description: 'Greet someone' },
  run(ctx) {
    const name = ctx.positionals[0] ?? 'World'
    ctx.io.write(`Hello, ${name}!`)
  },
})

Create main.ts:

import { run } from 'concise-ti'

void run({ name: 'my-cli', version: '1.0.0' }, import.meta)

Run it:

bun run ./main.ts hello Alice
# Hello, Alice!

Add a flag

export default command({
  meta: { description: 'Greet someone' },
  flags: {
    formal: { type: 'boolean', short: 'f', description: 'Use a formal greeting' },
  },
  run(ctx) {
    const name = ctx.positionals[0] ?? 'World'
    const greeting = ctx.flags.formal ? 'Greetings' : 'Hello'
    ctx.io.write(`${greeting}, ${name}!`)
  },
})
bun run ./main.ts hello Alice --formal
# Greetings, Alice!

Compile to a binary

Commands discovered from a commands/ directory need concise-ti compile, not bun build --compile directly: a compiled binary runs against a virtual filesystem that discoverManifest's directory scan can't see. concise-ti compile runs the entry once to resolve its manifest, then compiles the same, unchanged entry. See Compiling a Binary for the full guide.

bunx concise-ti compile ./main.ts --outfile dist/my-cli
./dist/my-cli hello Bob
# Hello, Bob!

Next steps