mirror of https://github.com/fazo96/homework-cli.git synced 2025-01-09 12:10:10 +01:00

command line interface for homework.meteor.com

Go to file

Enrico Fasoli e5fecb40f1 preparing for release		2015-03-09 15:56:02 +01:00
.gitignore	first commit	2015-03-09 10:05:40 +01:00
homework.js	new command to delete multiple notes	2015-03-09 15:20:22 +01:00
package.json	preparing for release	2015-03-09 15:56:02 +01:00
README.md	preparing for release	2015-03-09 15:56:02 +01:00

README.md

Homework CLI

Command line interface for Homework.

Setup

Install using npm install -g homework
Run with the homework command

By default, homework-cli connects to homework.meteor.com, but you can customize the url.
An account with an API key is required to access the RESTful API used by this tool. The API must also be enabled on the Homework server.

Please Note: as of the time of writing, Homework only has experimental RESTful API support, so this tool can't yet be used easily with homework.meteor.com.

Usage

Usage: homework [command] [arguments]

interact with a running instance of Homework (by default homework.meteor.com)

Commands:

  new [options] <title> [content]  create a new note
  delete <ids...>                  delete one or more notes

Options:

  -h, --help            output usage information
  -V, --version         output the version number
  -k, --key <apikey>    use given api key
  -u, --url <endpoint>  use given api endpoint instead of http://homework.meteor.com/api
  -v, --verbose         be more verbose
  -i, --id              show item IDs
  -s, --silent          don't print note list
  -a, --archived        view archived notes

If running with no commands, the tool will show your list of notes ordered by due date, just like the web interface.

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.