bocharsky-bw/console-google-tasks

An application for real console geeks which allows to interact with Google Tasks API directly in your terminal and based on the awesome Symfony Console component

dev-master 2016-08-28 08:50 UTC

Requires

• google/apiclient: ^2.0
• pimple/pimple: ^3.0
• symfony/console: ^3.1

MIT

• bocharsky-bw

• command line
• Agenda
• Google Tasks
• TODO list
• Things to be done
• TBD
• Console app
• Terminal app

README

An application for real console geeks which allows to interact with Google Tasks API directly in your terminal and based on the awesome Symfony Console component.

Table of contents

• Requirements
• Installation
• Usage
  • Create a Symlink
  • Short Command Aliases
• Command List
  • Task List Commands
  • Task Commands
• Contribution

Requirements

To use this application on your local host machine ensure you correspond to the next requirements:

• PHP 5.5 or higher
• Internet connection to get access to the Google API

Installation

With Composer

The preferred way to install this app is to use Composer. The next command installs this project globally on your local machine:

$ composer global install bocharsky-bw/console-google-tasks

Update

Composer helps you to easily update it to the latest version:

$ composer global update bocharsky-bw/console-google-tasks

With Git

An alternative way to install this app is to clone it locally first and then manually install dependencies with Composer:

$ git clone https://github.com/bocharsky-bw/ConsoleGoogleTasks.git
$ cd ./ConsoleGoogleTasks/
$ composer install

Update

You still can manually update it with Git by pulling latest changes from the master branch of source repository:

$ git pull origin master

Also don't forget to update dependencies with Composer by calling the next command in the project folder:

$ composer update

Usage

Start using this console application by calling the next command in your terminal:

$ ./bin/console.php # Shows list of available commands

Create a Symlink

For the convenience, you can create console.php symlink to get a quick access to the console application globally in any directory you are at:

$ ln -s /path/to/ConsoleGoogleTasks/bin/console.php /usr/local/bin/todo

Then you can simply get access to the console application globally with:

$ todo # Shows list of available commands

Use whatever alias you want here for the symlink name instead of todo one which uses in example.

Short Command Aliases

Thanks to the Symfony Console, it allows you do not type a full command. Just type a short unique part of a command starts from the beginning. For example, to get list of task lists:

$ todo list:list # Full command name
# Or just use a shortened command alias 
$ todo l:l # This command automatically recognizes by Symfony Console

Command List

List of available commands.

Task List Commands

Command	Description
list:create	Create task list
list:delete	Delete task list
list:list	List task lists
list:rename	Rename task list
list:show	Show task list

Task Commands

Command	Description
task:clear	Clear tasks
task:complete	Complete task
task:create	Create task
task:delete	Delete task
task:incomplete	Incomplete task
task:list	List tasks
task:rename	Rename task
task:show	Show task

Contribution

Contribution always are welcome! Feel free to submit an Issue or create a Pull Request if you find a bug or just want to propose an improvement.

In order to propose a new feature, the best way is to submit an Issue and discuss it first.

Move UP