@anku255/foam-cli v0.2.2

foam-cli

Foam CLI

• Usage
• Commands

Usage

$ npm install -g @anku255/foam-cli
$ foam COMMAND
running command...
$ foam (-v|--version|version)
@anku255/foam-cli/0.2.2 darwin-x64 node-v12.16.0
$ foam --help [COMMAND]
USAGE
  $ foam COMMAND
...

Commands

• foam hello [FILE]
• foam help [COMMAND]
• foam janitor [WORKSPACEPATH]

foam hello [FILE]

describe the command here

USAGE
  $ foam hello [FILE]

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

EXAMPLE
  $ foam hello
  hello world from ./src/hello.ts!

See code: src/commands/hello.ts

foam help [COMMAND]

display help for foam

USAGE
  $ foam help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

foam janitor [WORKSPACEPATH]

Updates link references and heading across all the markdown files in the given workspaces

USAGE
  $ foam janitor [WORKSPACEPATH]

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ foam-cli janitor path-to-foam-workspace
  Successfully generated link references and heading!

See code: src/commands/janitor.ts

Development

• Run yarn somewhere in workspace (ideally root, see yarn workspace docs
  • This will automatically symlink all package directories so you're using the local copy
• In packages/foam-core, run yarn start to rebuild the library on every change
• In packages/foam-cli, make changes and run with yarn run cli. This should use latest workspace manager changes.