Download the PHP package albertgrala/notes without Composer
On this page you can find all versions of the php package albertgrala/notes. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package notes
Notes
Notes helps you manage your notes when developing an application
By default the information is stored in a json file notes.json in the project root.
Installation
-
Update your composer.json to require
"albertgrala/notes": "dev-master"
. - Run
composer update
in the Terminal - Add the NotesServiceProvider
'Albertgrala\Notes\NotesServiceProvider'
to the laravel providers array in the fileapp/config/app.php
Commands
You can see the notes
commands typing php artisan
in the Terminal
Command | Description | Arguments | Options |
---|---|---|---|
notes:add |
Add a new note to your notes file | type |
|
notes:complete |
Mark a note as done | id |
|
notes:delete |
Delete a note | id |
all |
notes:show |
LList the notes | type |
all , done , today |
notes:add
The argument type
is required. Once entered the command, the terminal will ask you to describe your note
The note will be saved in the notes.json file. By default the type
is converted to uppercase.
Examples of type
: todo
, optimize
, fixme
, bug
notes:show
To list your notes is as easy as typing php artisan notes:show
, this will prompt all notes marked as uncompleted.
You can filter your notes by type
passing the argument. Use either the singular or plural form, uppercase or lowercase.
Flags
The --all
flag will prompt the notes completed and uncompleted. In this example we will list all the bugs notes.
The --done
flag will filter and prompt only the notes marked as completed.
The --today
flag will filter and prompt only the notes created today. In this example we will list all notes created today
You can combine flags to filter even more.
notes:complete
Pass the note id to mark a note as completed. The note will be marked as done and the time saved as completed_at
notes:delete
Pass the note id to delete a note
You can delete all the notes passing the flag --all
Json file
The notes.json has the following structure