@tometrove/cli

CLI tool for working with .tome files

Installation

npm install -g @tometrove/cli

Or use with npx without installing:

npx @tometrove/cli <command>

Usage

Create a .tome file from a directory

tome create <path-to-tome.json>

This command takes a path to a tome.json file and creates a .tome file from the parent directory. The process:

1. Validates that tome.json exists at the specified path
2. Zips the entire parent directory (where tome.json is located)
3. Renames the zip file to have a .tome extension

Example:

tome create /path/to/my-book/tome.json
# Creates: /path/to/my-book.tome

The tome.json file must be in the root of the directory you want to package as a tome file.

Read a .tome file

tome read <file>

Options:

• -v, --verbose - Display verbose output

Example:

tome read mybook.tome
tome read mybook.tome --verbose

Display file information

tome info <file>

Example:

tome info mybook.tome

Help

tome --help
tome <command> --help

Commands

• create <tomeJsonPath> - Create a .tome file from a directory containing tome.json
• read <file> - Read and display information about a .tome file
• info <file> - Display metadata about a .tome file

Development

Building

npm install
npm run build

Testing locally

npm run dev -- read test.tome

Or link globally:

npm link
tome read test.tome

Integration with tome-trove library

This CLI is designed to work with the tome-trove library for reading .tome files. To add the library as a dependency:

npm install tome-trove

Then update the CLI code to import and use the TomeReader from tome-trove.

License

ISC