Giter VIP home page Giter VIP logo

wand-cli's Introduction


Wand CLI is Node.js CLI memo tool 🧙✨

NPM Version Package License


wand-cli

Node.js CLI memo tool

Usage

Installation

npxでWand CLIを実行するために-gオプションを使用してライブラリをグローバルにインストールします。

$ npm i -g wand-cli

Basic workflow

インストールが完了するとwandコマンドを呼び出すことができます。 次のように入力して使用可能なコマンドを確認してください。

$ npx wand --help

まずはメモを管理するためのリモートリポジトリのURLを登録します。
下記コマンドを実行すると、対話形式でURLを求められるので入力してください。内部的にはgit cloneを行っており、成功するとユーザーのホームディレクトリ直下に/wandディレクトリが作成されます。

$ npx wand init

初期設定が完了したら下記のコマンドで新しいメモを作成してみましょう。
対話形式でメモのファイル名を聞かれます。特に指定がない場合はエンターを押してください。ランダムな文字列の.mdファイルが作成されます。

$ npx wand new

作成したメモを一覧表示することができます。

$ npx wand list

登録しているリモートリポジトリに変更内容をpushします。

$ npx wand save

Commadns

COMMANDS:
  wand init         Set up the repository and start Wand CLI.
  wand new          Create a new memo.
  wand list         Show the memo list.
  wand save         Save your changes and apply them to the remote repository.
  wand --help, -h   Show help.

Prerequisites

⚠️ 前提として、gitコマンドそのものが利用できる環境である必要があります。

License

MIT License © 2021 kazuhe

wand-cli's People

Contributors

kazuhe avatar

Stargazers

Andrew Johnson avatar

Watchers

 avatar

wand-cli's Issues

メモ(.md)作成機能

$ npx wand newで新しいメモ(.md)を作成する。
特に指定がなければユニークな文字列をタイトルにしてメモを作成し、指定があった場合は指定の名前でメモを作成する。

カテゴリー分類機能

カテゴリーをディレクトリで表現する。

wand/
.
├── categoryA
│   └── sample.md
├── test.md
└── z18tj1oype.md

$ npx wand newのタイミングでカテゴリーを選択or作成できるように実装する。

Usageドキュメント

CLIの使用方法をREADME.mdに記載する。
README.mdは日本語と英語を用意する。

ジェネレート機能

静的なHTMLにジェネレートするコマンドを用意する。
メモをGitHub Pagesに公開できるように/docsディレクトリに生成する。

プレビュー機能

マークダウン形式で記述されたメモをプレビューする機能を実装する。
詳細は未定だがホットリロード機能は最低限必要である。

Githubリポジトリ連携機能

ユーザーのGithubリポジトリとwand-cliの連携を行う機能を実装する。
v1では下記のget機能とsave機能を備える予定とする。

  • $ npx wand-cli get <Repository name>: リポジトリをローカルにclone
  • $ npx wand-cli save:リポジトリをcommitした後にpush

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.