Skip to main content
Home
Browse packagesDocsSign in

@scroogieboy/directory-to-object-cli@0.8.2
Built and signed on GitHub Actions

latest
cwirving/directory-to-object-cli

A simple command-line tool to demonstrate the @scroogieboy/directory-to-object package.

This package works with Deno
This package works with Deno
JSR Score
100%
Published
3 months ago (0.8.2)
Report package

directory-to-object-cli

A simple CLI tool to exercise the directory-to-object and zip-to-object packages.

This tool loads a directory using @scroogieboy/directory-to-object then prints the results. The default output format is the Deno.inspect format. The default output location is the console. When the --from-zip command line option is specified, the contents will be read from a Zip archive (or file that uses the Zip archive format, such as Microsoft Office document) instead of a directory.

The underlying package is portable across runtimes, but this particular CLI is intended for Deno only.

Run it from the Deno command line with:

deno run --allow-read --allow-write jsr:@scroogieboy/directory-to-object-cli

Note: The --allow-write option is only required if using the --output flag to write the command output to a file.

It can also be installed as a global command with:

deno install --allow-read --allow-write --name directory-to-object-cli jsr:@scroogieboy/directory-to-object-cli

Usage

Usage: directory-to-object-cli <path>

Description:

  A CLI for the '@scroogieboy/directory-to-object' package

Options:

  -h, --help                        - Show this help.
  -n, --nodefaults                  - Remove all default file value loaders.
  -b, --binary         <extension>  - Map additional file extension to binary format.
  -c, --colors                      - Colorize Deno.inspect output.
  -e, --embed-dir      <key>        - Embed the URL of every directory traversed using this key.
  -E, --embed-file     <key>        - Embed the URL of every object-valued (e.g., JSON) file traversed using this key.
  -f, --format         <format>     - The output format -- 'inspect' (default) or 'json'.
  -j, --json           <extension>  - Map additional file extension to JSON format.
  -J, --jsonc          <extension>  - Map additional file extension to JSON-with-comments (JSONC) format.
  -M, --merge-arrays                - Merge any conflicting arrays in configuration using the es-toolkit `union`
                                      function.
  -m, --merge-objects               - Merge any conflicting objects in configuration using the es-toolkit `merge`
                                      function.
  -o, --output         <path>       - Write output to this file.
  -t, --text           <extension>  - Map additional file extension to textual format.
  -v, --verbose                     - Enable verbose logging.
  -x, --xml            <extension>  - Map additional file extension to XML format.
  -y, --yaml           <extension>  - Map additional file extension to YAML format.
  -Z, --from-zip                    - Load contents from a zip archive instead of a directory.
Built and signed on
GitHub Actions
View transparency log

Add Package

deno add jsr:@scroogieboy/directory-to-object-cli

Import symbol

import * as directory_to_object_cli from "@scroogieboy/directory-to-object-cli";

---- OR ----

Import directly with a jsr specifier

import * as directory_to_object_cli from "jsr:@scroogieboy/directory-to-object-cli";