O console forma a ponte entre o Hexo e os usuários. Ele registra e descreve os comandos disponíveis para o terminal.

Resumo

hexo.extend.console.register(name, desc, options, function(args){
  // ...
});

Um argumento args será passado para a função. Este é o argumento que os usuários digitam no terminal. Ele é analisado pelo Minimist.

Opções

usage

O uso de um comando de terminal. Por exemplo:

{usage: '[layout] <title>'}
// hexo new [layout] <title>

arguments

A descrição de cada argumento de um comando de terminal. Por exemplo:

{
  arguments: [
    {name: 'layout', desc: 'Post layout'},
    {name: 'title', desc: 'Post title'}
  ]
}

options

A descrição de cada opção de um comando de terminal. Por exemplo:

{
  options: [
    {name: '-r, --replace', desc: 'Replace existing files'}
  ]
}

desc

Informações mais detalhadas sobre um comando de terminal.

Exemplo

hexo.extend.console.register('config', 'Display configuration', function(args){
  console.log(hexo.config);
});