@gizmo-v-nk/file-checklist-generator
v1.0.1
Published
Generate a markdown file checklist for files and directories
Maintainers
Readme
��#� �F�i�l�e�-�C�h�e�c�k�l�i�s�t�-�G�e�n�e�r�a�t�o�r�
�
�
�
�!�[�i�m�a�g�e�]�(�i�m�g�/�t�i�t�l�e�.�p�n�g�)�
�
�
�
�#�#� �S�u�m�m�a�r�y�
�
�
�
�G�e�n�e�r�a�t�e� �a� �M�a�r�k�d�o�w�n� �c�h�e�c�k�l�i�s�t� �o�f� �f�i�l�e�s� �a�n�d� �d�i�r�e�c�t�o�r�i�e�s�.�
�
�
�
�#�#� �I�n�s�t�a�l�l�
�
�
�
����
�
�n�p�m� �i� �-�D� �@�g�i�z�m�o�-�v�-�n�k�/�f�i�l�e�-�c�h�e�c�k�l�i�s�t�-�g�e�n�e�r�a�t�o�r�
�
����
�
�
�
�#�#� �U�s�a�g�e�
�
�
�
�A�s� �a� �C�L�I�:�
�
�
�
����
�
�g�e�n�e�r�a�t�e�-�f�i�l�e�-�c�h�e�c�k�l�i�s�t� �-�i� �<�p�a�t�h�>� �[�-�f�]� �[�-�d�]� �[�-�o� �<�o�u�t�p�u�t�>�]�
�
����
�
�
�
�P�r�o�g�r�a�m�m�a�t�i�c�a�l�l�y�:�
�
�
�
����t�s�
�
�i�m�p�o�r�t� �{� �g�e�n�e�r�a�t�e�C�h�e�c�k�l�i�s�t� �}� �f�r�o�m� �'�@�g�i�z�m�o�-�v�-�n�k�/�f�i�l�e�-�c�h�e�c�k�l�i�s�t�-�g�e�n�e�r�a�t�o�r�'�
�
�
�
�c�o�n�s�t� �{� �m�d�,� �o�u�t�P�a�t�h� �}� �=� �g�e�n�e�r�a�t�e�C�h�e�c�k�l�i�s�t�(�{� �i�n�p�u�t�:� �'�s�r�c�'� �}�)�
�
����
�
�
�
�#�#� �O�p�t�i�o�n�s�
�
�
�
�-� ��-�i�,� �-�-�i�n�p�u�t�� �t�a�r�g�e�t� �d�i�r�e�c�t�o�r�y� �(�r�e�q�u�i�r�e�d�)�
�
�-� ��-�f�,� �-�-�f�i�l�e�� �l�i�s�t� �f�i�l�e�s� �o�n�l�y�
�
�-� ��-�d�,� �-�-�d�i�r�e�c�t�o�r�y�� �l�i�s�t� �d�i�r�e�c�t�o�r�i�e�s� �o�n�l�y�
�
�-� ��-�x�,� �-�-�f�i�l�t�e�r�� �p�a�t�h� �f�i�l�t�e�r� �(�g�l�o�b� �o�r� �r�e�g�e�x�)�.� �E�x�a�m�p�l�e�s�:� ��"�*�.�t�s�"�� �o�r� ��/�\�\�.�t�s�$�/��
�
�-� ��-�o�,� �-�-�o�u�t�p�u�t�� �o�u�t�p�u�t� �p�a�t�h�.� �I�f� �a� �d�i�r�e�c�t�o�r�y� �i�s� �s�p�e�c�i�f�i�e�d� �o�r� �o�m�i�t�t�e�d� �a�n� �a�u�t�o�-�n�a�m�e�d� �f�i�l�e� ��y�y�y�y�m�m�d�d�h�h�m�m�s�s�.�c�h�e�c�k�l�i�s�t�.�m�d�� �w�i�l�l� �b�e� �c�r�e�a�t�e�d� �i�n� �t�h�e� �C�L�I� �i�n�s�t�a�l�l� �d�i�r�e�c�t�o�r�y�.�
�
�
�
�
