Skip to main content Link Search Menu Expand Document (external link)

bin overview

CLI entry point for the note command.

Added in v0.1.0


Table of contents


Errors

ExistingArgFile (class)

Error when an argument matches an existing file in the current directory.

Signature

export declare class ExistingArgFile

Added in v0.1.0

FileAlreadyExists (class)

Error when the target note file already exists.

Signature

export declare class FileAlreadyExists

Added in v0.1.0

NoteError (type alias)

CLI-specific errors with user-friendly messages.

Signature

export type NoteError = ExistingArgFile | FileAlreadyExists | WriteError

Added in v0.1.0

WriteError (class)

Error when file write fails.

Signature

export declare class WriteError

Added in v0.1.0

utils

run

Run the CLI with the given arguments.

Signature

export declare const run: (
  args: ReadonlyArray<string>
) => Effect.Effect<void, PlatformError | ValidationError, CliApp.Environment>

Added in v0.1.0