Executando verificação de segurança...
4

Ferramenta de CLI: tldr

tldr, ou "too long, didn't read"

Não é assim que vocês se sentem quando tentam lembrar qual a sintaxe de algum programa na linha de comando e, antes de abrir o Google, tentam rodar man nome-do-programa? Um texto seco, enorme, cheio de metassintaxe difícil de ler, mais uma referência hardcore do que algo realmente útil pra só tirar uma dúvida rápida?

Bem, eu lembrei agora dessa ferramenta que uso frequentemente, e precisava compartilhar com quem ainda não conhece. Basicamente, ela te mostra uma orientação muito mais sucinta e orientada a exemplos do programa do que as manpages. Exemplos de saída:

➜  ~ tldr chmod 
chmod
Change the access permissions of a file or directory.More information: https://www.gnu.org/software/coreutils/chmod.

 - Give the [u]ser who owns a file the right to e[x]ecute it:
   chmod u+x {{path/to/file}}

 - Give the [u]ser rights to [r]ead and [w]rite to a file/directory:
   chmod u+rw {{path/to/file_or_directory}}

 - Remove e[x]ecutable rights from the [g]roup:
   chmod g-x {{path/to/file}}

 - Give [a]ll users rights to [r]ead and e[x]ecute:
   chmod a+rx {{path/to/file}}

 - Give [o]thers (not in the file owner's group) the same rights as the [g]roup:
   chmod o=g {{path/to/file}}

 - Remove all rights from [o]thers:
   chmod o= {{path/to/file}}

 - Change permissions recursively giving [g]roup and [o]thers the ability to [w]rite:
   chmod -R g+w,o+w {{path/to/directory}}

 - Recursively give [a]ll users [r]ead permissions to files and e[X]ecute permissions to sub-directories within a directory:
   chmod -R a+rX {{path/to/directory}}


➜  ~ tldr ln 
ln
Creates links to files and directories.More information: https://www.gnu.org/software/coreutils/ln.

 - Create a symbolic link to a file or directory:
   ln -s {{/path/to/file_or_directory}} {{path/to/symlink}}

 - Overwrite an existing symbolic link to point to a different file:
   ln -sf {{/path/to/new_file}} {{path/to/symlink}}

 - Create a hard link to a file:
   ln {{/path/to/file}} {{path/to/hardlink}}


Pra instalar

Tal como diz no site linkado no título, é só ter o Node.js instalado e rodar
npm install -g tldr

Na primeira execução do arquivo ele vai baixar as informações de repositórios, e pronto, já dá pra sair usando.

Espero que seja útil pra alguém. Até a próxima!

Carregando publicação patrocinada...
1
1

Poxa nao conhecia a ferramenta. Man pages parecem aquelas bulas de remedio cheio de fru-fru sendo que o que se procura esta em 2-3 paragrafos.

4

Eu vejo como ferramentas diferentes, com propósitos diferentes.

A ideia da man page é ser a referência completa do comando, com todas as opções disponíveis, funcionamento, etc.

Já o tldr tem outro objetivo: até onde entendi, a ideia é mostrar exemplos dos casos de uso mais comuns.

O problema é usar um quando na verdade precisa do outro (e culpar a ferramenta por isso).

São coisas complementares. Muitas vezes vc só quer o caso básico mesmo. Mas se precisar de algo mais específico e complicado, não tem jeito, vai ter que se aprofundar na man page. Um não substitui o outro, tanto que um problema que vejo muito é a pessoa só decorar o caso básico e usar pra tudo (mesmo quando precisa de opções mais avançadas).

1

A questão é que historicamente a resposta canônica do pessoal sempre foi "RTFM", especialmente na cultura de fóruns pré-StackOverflow, mesmo quando o cara só queria uma resposta simples e rápida. O tldr parece atender a essa necessidade que manpages dificilmente atendiam, ainda que fossem frequentemente recomendadas.

1

A questão do RTFM eu vejo mais como um problema de atitude das pessoas, do que da ferramenta em si. Mas entendi o seu ponto :-)

1

Seu comentário foi perfeito na descrição da diferença entre "man" e tldr, um só precisa mostrar os exemplos de uso enquanto outro é um manual // documentação de todo o projeto e o necessário sendo usar ambos para aprender a controlar o sistema

1

Exato por isso que open-source tem uma cacetada de ferramentas. Eu particularmente nao gosto do man, acho prolixo demais, mas tem sua utilidade, nao para o que uso no dia a dia.