adoyle-cli

A CLI for personal tasks, which implemented with NodeJS.

TOC

• Installation
• Quick Start
• Configuration
• Auto-Completion
  • If you are using bash
  • If you are using zsh
  • If you are using fish
• Versioning
• Copyright and License

Installation

npm install -g adoyle-cli

Quick Start

1. Installation
2. Set Auto-Completion
3. Just invoke adoyle in shell.

Configuration

Some commands need configuration. You should create a file named ~/.adoyle-cli.rc with non-strict JSON syntax implemented by JSON5.

{
    github-token: '...',
    dirs: {
    }
}

Auto-Completion

If you are using bash

# For bash
source <(adoyle completion bash)

# or add it to your .bashrc to make it persist
echo "source <(adoyle completion bash)" >> ~/.bashrc \
&& source ~/.bashrc

If you are using zsh

# For zsh
source <(adoyle completion zsh)

# or add it to your .zshrc to make it persist
echo "source <(adoyle completion zsh)" >> ~/.zshrc \
&& source ~/.zshrc

If you are using fish

# For fish
source <(adoyle completion fish)

# or add it to your config.fish to make it persist
echo "source <(adoyle completion fish)" >> ~/.config/fish/config.fish \
&& source ~/.config/fish/config.fish

https://github.com/mattallty/Caporal.js#shell-auto-completion

Versioning

The versioning follows the rules of SemVer 2.0.0.

BUT, anything may have BREAKING CHANGES at ANY TIME when major version is zero (0.y.z), which is for initial development and the public API should be considered unstable.

For more information on SemVer, please visit http://semver.org/.

Copyright and License

Copyright (c) 2017-2018 ADoyle. The project is licensed under the Apache License Version 2.0.

See the LICENSE file for the specific language governing permissions and limitations under the License.

See the NOTICE file distributed with this work for additional information regarding copyright ownership.