https://github.com/madeindjs/notable-cli

https://github.com/madeindjs/notable-cli

Last synced: over 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/madeindjs/notable-cli
• Owner: madeindjs
• Archived: true
• Created: 2021-01-30T07:54:28.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-01-30T10:13:29.000Z (over 5 years ago)
• Last Synced: 2025-02-05T21:41:45.231Z (over 1 year ago)
• Language: TypeScript
• Size: 170 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# notable-cli

A Notable command line client

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)

[![Version](https://img.shields.io/npm/v/notable-cli.svg)](https://npmjs.org/package/notable-cli)

[![Downloads/week](https://img.shields.io/npm/dw/notable-cli.svg)](https://npmjs.org/package/notable-cli)

[![License](https://img.shields.io/npm/l/notable-cli.svg)](https://github.com/madeindjs/notable-cli/blob/master/package.json)

![Screenshot of search feature](https://raw.githubusercontent.com/madeindjs/notable-cli/master/screenshots/search.webm)

- [Usage](#usage)

- [Commands](#commands)

# Usage

```sh-session

$ npm install -g notable-cli

$ notable-cli COMMAND

running command...

$ notable-cli (-v|--version|version)

notable-cli/0.0.0 linux-x64 node-v12.18.2

$ notable-cli --help [COMMAND]

USAGE

  $ notable-cli COMMAND

...

```

# Commands

- [`notable-cli hello [FILE]`](#notable-cli-hello-file)

- [`notable-cli help [COMMAND]`](#notable-cli-help-command)

- [`notable-cli search`](#notable-cli-search)

- [`notable-cli settings`](#notable-cli-settings)

## `notable-cli hello [FILE]`

describe the command here

```

USAGE

  $ notable-cli hello [FILE]

OPTIONS

  -f, --force

  -h, --help       show CLI help

  -n, --name=name  name to print

  -t, --test

EXAMPLE

  $ notable-cli hello

  hello world from ./src/hello.ts!

```

_See code: [src/commands/hello.ts](https://github.com/madeindjs/notable-cli/blob/v0.0.0/src/commands/hello.ts)_

## `notable-cli help [COMMAND]`

display help for notable-cli

```

USAGE

  $ notable-cli help [COMMAND]

ARGUMENTS

  COMMAND  command to show help for

OPTIONS

  --all  see all commands in CLI

```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.1/src/commands/help.ts)_

## `notable-cli search`

describe the command here

```

USAGE

  $ notable-cli search

OPTIONS

  -c, --content=content

  -h, --help             show CLI help

  -t, --tags=tags        Tags to search

EXAMPLE

  $ notable-cli search -t nodejs -c Cheatsheet

  /home/alexandre/Documents/@plaintext/notes/Javascript - Cheatsheet.md

```

_See code: [src/commands/search.ts](https://github.com/madeindjs/notable-cli/blob/v0.0.0/src/commands/search.ts)_

## `notable-cli settings`

Set settings of notable-cli

```

USAGE

  $ notable-cli settings

OPTIONS

  -h, --help       show CLI help

  -p, --path=path  Set path of Notables notes

EXAMPLE

  $ notable-cli settings --path ~/Notable/notes

```

_See code: [src/commands/settings.ts](https://github.com/madeindjs/notable-cli/blob/v0.0.0/src/commands/settings.ts)_