2017 © Pedro Peláez
 

project verbal

A minimalist blog engine driven by command line.

image

tonylaurent/verbal

A minimalist blog engine driven by command line.

  • Monday, June 18, 2018
  • by tonylaurent
  • Repository
  • 1 Watchers
  • 0 Stars
  • 19 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 1 Versions
  • 850 % Grown

The README.md

Build Status, (*1)

About

Verbal is the blog engine for command lines addicts., (*2)

Verbal, (*3)

Requirements

Verbal is built on Laravel and use SQLite as embedded database:, (*4)

  • PHP >= 7.0.0
  • OpenSSL PHP Extension
  • PDO PHP Extension
  • Mbstring PHP Extension
  • Tokenizer PHP Extension
  • XML PHP Extension
  • SQLite 3
  • Composer

Installation

Create your blog project with Composer:, (*5)

composer create-project --prefer-dist tonylaurent/verbal blog dev-master

Move to your project directory, start the built-in server and go to http://localhost:8000 (only for testing):, (*6)

php artisan serve

You can populate your blog with fake data:, (*7)

php artisan db:seed

Set your blog informations in the config file config/blog.php., (*8)

Getting started

First, create a tag to categorize your post:, (*9)

$ php artisan tag:add "Foo" --description="This is my first tag"

Write your first post (the content must be in markdown format):, (*10)

$ php artisan post:add "My first post" --tag="Foo" --summary="This is my first post" --content="# Hello world!"

If you need a multi-line content, type enter after the first double quote and finish with an other double quote:, (*11)

$ php artisan post:add "My first post" --tag="Foo" --summary="This is my first post" --content="
> # Hello world!
> This is the first paragraph.
>
> This is the second paragraph.
> "

You can custom the post datetime instead of use the default current timestamp:, (*12)

$ php artisan post:add "My first post" --datetime="2018-01-01 12:30:00"

Maybe need a picture to illustrate your post?, (*13)

$ php artisan post:add "My first post" --image="/home/tony/picture.png"

Usage

Posts

Add a new post

$ php artisan post:add TITLE [OPTIONS]

Arguments
"TITLE" The title of the post to add, (*14)

Options
--summary="SUMMARY" Set the post’s summary
--content="CONTENT" Set the post’s content (markdown format)
--datetime="YYYY-MM-DD MM:HH:SS" Set the post’s datetime
--image="PATH" Set the post’s image
--tag="NAME" Categorize the post with a tag name (multiple values allowed), (*15)

Browse all posts

$ php artisan post:browse [OPTIONS]

Options
--show="COLUMN" Show the specified column (multiple values allowed)
--hide="COLUMN" Hide the specified column (multiple values allowed)
--sort="COLUMN" Sort by the specified column
--reverse Reverse sort order, (*16)

Read an existing post

$ php artisan post:read ID

Arguments
ID The ID of the post to read, (*17)

Edit an existing post

$ php artisan post:edit ID [OPTIONS]

Arguments
ID The ID of the post to edit, (*18)

Options
--title="TITLE" Change the post’s title
--summary="SUMMARY" Change the post’s summary
--content="CONTENT" Change the post’s content (markdown format)
--datetime="YYYY-MM-DD MM:HH:SS" Change the post’s datetime
--image="PATH" Change the post’s image
--tag="NAME" Categorize the post with a tag (multiple values allowed), (*19)

Delete an existing post

$ php artisan post:delete ID [OPTIONS]

Arguments
ID The ID of the post to delete, (*20)

Options
--force Skip confirmation, (*21)

Tag an existing post

$ php artisan post:tag ID [OPTIONS]

Arguments
ID The ID of the post to tag, (*22)

Options
--tag="NAME" The tag’s name to add (multiple values allowed), (*23)

Untag an existing post

$ php artisan post:untag ID [OPTIONS]

Arguments
ID The ID of the post to untag, (*24)

Options
--tag="NAME" The tag’s name to remove (multiple values allowed), (*25)

Tags

Add a new tag

$ php artisan tag:add NAME [OPTIONS]

Arguments
"NAME" The name of the tag to add, (*26)

Options
--description="DESCRIPTION" Set the tag’s description, (*27)

Browse all tags

$ php artisan tag:browse [OPTIONS]

Options
--show="COLUMN" Show the specified column (multiple values allowed)
--hide="COLUMN" Hide the specified column (multiple values allowed)
--sort="COLUMN" Sort by the specified column
--reverse Reverse sort order, (*28)

Read an existing tag

$ php artisan tag:read ID

Arguments
ID The ID of the tag to read, (*29)

Edit an existing tag

$ php artisan tag:edit ID [OPTIONS]

Arguments
ID The ID of the tag to edit, (*30)

Options
--name="NAME" Change the tag’s name
--description="DESCRIPTION" Change the tag’s description, (*31)

Delete an existing tag

$ php artisan tag:delete ID [OPTIONS]

Arguments
ID The ID of the tag to delete, (*32)

Options
--force Skip confirmation, (*33)

The Versions