GitHubHelp

john-hu/mac-say

A node command line tool to trigger mac say command and save the file in a predefined pattern

★ 0Forks 0TypeScriptGitHub ↗Compare

README

mac-say

A Node.js command line tool to trigger Mac's say command and save audio files in a predefined pattern.

oclif Version Downloads/week

Usage

$ npm install -g mac-say
$ mac-say COMMAND
running command...
$ mac-say (--version)
mac-say/0.0.2 darwin-arm64 node-v22.19.0
$ mac-say --help [COMMAND]
USAGE
  $ mac-say COMMAND
...

Commands

mac-say help [COMMAND]

Display help for mac-say.

USAGE
  $ mac-say help [COMMAND...] [-n]

ARGUMENTS
  COMMAND...  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for mac-say.

See code: @oclif/plugin-help

mac-say mac-say FILE

Convert text file with sections to speech files using Mac say command

USAGE
  $ mac-say mac-say FILE [-h] [-o <value>]

ARGUMENTS
  FILE  Input text file to process

FLAGS
  -h, --help                Show CLI help.
  -o, --output-dir=<value>  [default: ./output] Output directory for audio files

DESCRIPTION
  Convert text file with sections to speech files using Mac say command

EXAMPLES
  $ mac-say mac-say input.txt --output-dir ./audio

See code: src/commands/mac-say/index.ts

mac-say plugins

List installed plugins.

USAGE
  $ mac-say plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ mac-say plugins

See code: @oclif/plugin-plugins

mac-say plugins add PLUGIN

Installs a plugin into mac-say.

USAGE
  $ mac-say plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into mac-say.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the MAC_SAY_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the MAC_SAY_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ mac-say plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ mac-say plugins add myplugin

  Install a plugin from a github url.

    $ mac-say plugins add https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ mac-say plugins add someuser/someplugin

mac-say plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ mac-say plugins inspect PLUGIN...

ARGUMENTS
  PLUGIN...  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ mac-say plugins inspect myplugin

See code: @oclif/plugin-plugins

mac-say plugins install PLUGIN

Installs a plugin into mac-say.

USAGE
  $ mac-say plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into mac-say.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the MAC_SAY_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the MAC_SAY_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ mac-say plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ mac-say plugins install myplugin

  Install a plugin from a github url.

    $ mac-say plugins install https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ mac-say plugins install someuser/someplugin

See code: @oclif/plugin-plugins

mac-say plugins link PATH

Links a plugin into the CLI for development.

USAGE
  $ mac-say plugins link PATH [-h] [--install] [-v]

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help          Show CLI help.
  -v, --verbose
      --[no-]install  Install dependencies after linking the plugin.

DESCRIPTION
  Links a plugin into the CLI for development.

  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.


EXAMPLES
  $ mac-say plugins link myplugin

See code: @oclif/plugin-plugins

mac-say plugins remove [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ mac-say plugins remove [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ mac-say plugins unlink
  $ mac-say plugins remove

EXAMPLES
  $ mac-say plugins remove myplugin

mac-say plugins reset

Remove all user-installed and linked plugins.

USAGE
  $ mac-say plugins reset [--hard] [--reinstall]

FLAGS
  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
  --reinstall  Reinstall all plugins after uninstalling.

See code: @oclif/plugin-plugins

mac-say plugins uninstall [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ mac-say plugins uninstall [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ mac-say plugins unlink
  $ mac-say plugins remove

EXAMPLES
  $ mac-say plugins uninstall myplugin

See code: @oclif/plugin-plugins

mac-say plugins unlink [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ mac-say plugins unlink [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ mac-say plugins unlink
  $ mac-say plugins remove

EXAMPLES
  $ mac-say plugins unlink myplugin

mac-say plugins update

Update installed plugins.

USAGE
  $ mac-say plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

Contributors

john-hu

Issues