divya-drishti
v1.0.0
Published
Policy-driven AI code auditor and remediation CLI for security, logic, performance, and UI checks.
Maintainers
Readme
��#� �D�i�v�y�a� �D�r�i�s�h�t�i� �G�i�t�A�g�e�n�t�
�
�
�
���A�I�-�p�o�w�e�r�e�d� �c�o�d�e� �a�u�d�i�t�o�r� �a�n�d� �w�o�r�k�f�l�o�w� �a�g�e�n�t� �f�o�r� �s�e�c�u�r�i�t�y�,� �l�o�g�i�c�,� �p�e�r�f�o�r�m�a�n�c�e�,� �a�n�d� �U�I� �c�h�e�c�k�s�.���
�
�
�
�[�!�[�n�p�m� �v�e�r�s�i�o�n�]�(�h�t�t�p�s�:�/�/�i�m�g�.�s�h�i�e�l�d�s�.�i�o�/�n�p�m�/�v�/�d�i�v�y�a�-�d�r�i�s�h�t�i�-�a�g�e�n�t�.�s�v�g�)�]�(�h�t�t�p�s�:�/�/�w�w�w�.�n�p�m�j�s�.�c�o�m�/�p�a�c�k�a�g�e�/�d�i�v�y�a�-�d�r�i�s�h�t�i�-�a�g�e�n�t�)�
�
�[�!�[�l�i�c�e�n�s�e�]�(�h�t�t�p�s�:�/�/�i�m�g�.�s�h�i�e�l�d�s�.�i�o�/�b�a�d�g�e�/�l�i�c�e�n�s�e�-�M�I�T�-�b�l�u�e�.�s�v�g�)�]�(�L�I�C�E�N�S�E�)�
�
�
�
�#�#� �O�v�e�r�v�i�e�w�
�
�
�
�D�i�v�y�a� �D�r�i�s�h�t�i� �G�i�t�A�g�e�n�t� �i�s� �a� �m�o�d�u�l�a�r� �a�u�d�i�t�i�n�g� �s�y�s�t�e�m� �d�e�s�i�g�n�e�d� �t�o� �a�n�a�l�y�z�e� �c�o�d�e�b�a�s�e�s� �b�e�f�o�r�e� �d�e�p�l�o�y�m�e�n�t�.� �I�t� �r�e�a�d�s� �p�r�o�j�e�c�t� �f�i�l�e�s�,� �r�u�n�s� �s�p�e�c�i�a�l�i�z�e�d� �s�c�a�n�n�e�r�s�,� �g�e�n�e�r�a�t�e�s� �a� �s�t�r�u�c�t�u�r�e�d� �r�e�p�o�r�t�,� �a�n�d� �c�a�n� �o�p�t�i�o�n�a�l�l�y� �c�r�e�a�t�e� �G�i�t� �c�o�m�m�i�t�s� �o�r� �p�u�l�l� �r�e�q�u�e�s�t�s� �a�s� �p�a�r�t� �o�f� �a�n� �a�u�t�o�m�a�t�e�d� �w�o�r�k�f�l�o�w�.�
�
�
�
�I�t� �i�s� �b�u�i�l�t� �f�o�r�:�
�
�
�
�� �G�i�t�H�u�b� �r�e�p�o�s�i�t�o�r�i�e�s�
�
�� �L�o�c�a�l� �d�e�v�e�l�o�p�m�e�n�t� �p�r�o�j�e�c�t�s�
�
�� �C�I�/�C�D� �p�i�p�e�l�i�n�e�s�
�
�� �N�P�M�-�b�a�s�e�d� �d�i�s�t�r�i�b�u�t�i�o�n�
�
�
�
�#�#� �K�e�y� �F�e�a�t�u�r�e�s�
�
�
�
�� ���F�i�l�e� �R�e�a�d�e�r���:� �d�i�s�c�o�v�e�r�s� �a�n�d� �s�a�f�e�l�y� �r�e�a�d�s� �p�r�o�j�e�c�t� �f�i�l�e�s�
�
�� ���S�e�c�u�r�i�t�y� �S�c�a�n�n�e�r���:� �d�e�t�e�c�t�s� �u�n�s�a�f�e� �p�a�t�t�e�r�n�s�,� �s�e�c�r�e�t�s�,� �i�n�j�e�c�t�i�o�n� �r�i�s�k�s�,� �a�n�d� �w�e�a�k� �c�o�n�t�r�o�l�s�
�
�� ���L�o�g�i�c� �S�c�a�n�n�e�r���:� �c�h�e�c�k�s� �f�l�o�w�,� �a�c�c�e�s�s� �c�o�n�t�r�o�l�,� �a�n�d� �b�u�s�i�n�e�s�s� �l�o�g�i�c� �i�s�s�u�e�s�
�
�� ���P�e�r�f�o�r�m�a�n�c�e� �S�c�a�n�n�e�r���:� �i�d�e�n�t�i�f�i�e�s� �b�o�t�t�l�e�n�e�c�k�s�,� �i�n�e�f�f�i�c�i�e�n�t� �l�o�o�p�s�,� �b�l�o�c�k�i�n�g� �I�/�O�,� �a�n�d� �m�e�m�o�r�y� �r�i�s�k�s�
�
�� ���U�I� �S�k�e�l�e�t�o�n� �G�e�n�e�r�a�t�o�r���:� �s�u�g�g�e�s�t�s� �l�o�a�d�i�n�g�-�s�t�a�t�e� �a�n�d� �U�X� �i�m�p�r�o�v�e�m�e�n�t�s�
�
�� ���R�e�p�o�r�t� �G�e�n�e�r�a�t�o�r���:� �c�r�e�a�t�e�s� �s�t�r�u�c�t�u�r�e�d�,� �d�e�d�u�p�l�i�c�a�t�e�d� �a�u�d�i�t� �r�e�p�o�r�t�s� �i�n� �M�a�r�k�d�o�w�n� �a�n�d� �J�S�O�N�
�
�� ���G�i�t� �M�a�n�a�g�e�r���:� �s�t�a�g�e�s� �r�e�p�o�r�t�s�,� �c�o�m�m�i�t�s� �c�h�a�n�g�e�s�,� �a�n�d� �s�u�p�p�o�r�t�s� �P�R� �w�o�r�k�f�l�o�w�s�
�
�� ���R�u�l�e�s� �E�n�g�i�n�e���:� �p�o�l�i�c�y�-�d�r�i�v�e�n� �A�I� �p�r�o�m�p�t� �a�n�d� �c�o�d�e� �g�e�n�e�r�a�t�i�o�n� �s�u�p�p�o�r�t�
�
�� ���A�u�t�o�-�F�i�x� �/� �P�a�t�c�h� �S�u�g�g�e�s�t�i�o�n�s���:� �g�e�n�e�r�a�t�e�s� �r�e�v�i�e�w�a�b�l�e� �r�e�m�e�d�i�a�t�i�o�n� �s�u�g�g�e�s�t�i�o�n�s� �f�o�r� �d�e�t�e�c�t�e�d� �i�s�s�u�e�s�
�
�
�
�#�#� �W�h�a�t� �I�t� �P�r�o�d�u�c�e�s�
�
�
�
�� ��A�U�D�I�T�_�R�E�P�O�R�T�.�m�d�� �f�o�r� �h�u�m�a�n�-�r�e�a�d�a�b�l�e� �f�i�n�d�i�n�g�s�
�
�� ��m�e�m�o�r�y�/�f�i�n�a�l�-�r�e�p�o�r�t�.�j�s�o�n�� �f�o�r� �s�t�r�u�c�t�u�r�e�d� �o�u�t�p�u�t�
�
�� ��m�e�m�o�r�y�/�p�a�t�c�h�e�s�.�j�s�o�n�� �f�o�r� �f�i�x� �s�u�g�g�e�s�t�i�o�n�s�
�
�� ��m�e�m�o�r�y�/�*�.�j�s�o�n�� �f�o�r� �i�n�t�e�r�m�e�d�i�a�t�e� �s�c�a�n�n�e�r� �o�u�t�p�u�t�
�
�� �O�p�t�i�o�n�a�l� �P�D�F� �r�e�p�o�r�t� �d�e�p�e�n�d�i�n�g� �o�n� �y�o�u�r� �p�i�p�e�l�i�n�e� �s�e�t�u�p�
�
�
�
�#�#� �P�r�o�j�e�c�t� �S�t�r�u�c�t�u�r�e�
�
�
�
����t�e�x�t�
�
�c�o�r�e�/� � � � � � � � � � � � � � �E�n�g�i�n�e�,� �p�i�p�e�l�i�n�e�,� �a�u�t�o�-�f�i�x�,� �p�a�t�c�h� �g�e�n�e�r�a�t�i�o�n�
�
�s�k�i�l�l�s�/� � � � � � � � � � � � �S�e�c�u�r�i�t�y�,� �l�o�g�i�c�,� �p�e�r�f�o�r�m�a�n�c�e�,� �U�I�,� �r�e�p�o�r�t�,� �a�n�d� �g�i�t� �s�k�i�l�l�s�
�
�m�e�m�o�r�y�/� � � � � � � � � � � � �I�n�t�e�r�m�e�d�i�a�t�e� �a�n�d� �f�i�n�a�l� �a�u�d�i�t� �o�u�t�p�u�t�
�
�r�u�l�e�s�/� � � � � � � � � � � � � � �R�u�l�e�s� �a�n�d� �p�o�l�i�c�y� �d�e�f�i�n�i�t�i�o�n�s�
�
�u�t�i�l�s�/� � � � � � � � � � � � � �H�e�l�p�e�r�s�,� �l�o�g�g�e�r�,� �Y�A�M�L� �l�o�a�d�e�r�
�
�c�l�i�.�j�s� � � � � � � � � � � � � �C�o�m�m�a�n�d� �l�i�n�e� �i�n�t�e�r�f�a�c�e�
�
�i�n�d�e�x�.�j�s� � � � � � � � � � � �E�n�t�r�y� �p�o�i�n�t� �f�o�r� �l�o�c�a�l� �e�x�e�c�u�t�i�o�n�
�
�p�i�p�e�l�i�n�e�.�j�s� � � � � � � � �M�a�i�n� �p�i�p�e�l�i�n�e� �o�r�c�h�e�s�t�r�a�t�i�o�n�
�
�a�g�e�n�t�.�y�a�m�l� � � � � � � � � �A�g�e�n�t� �c�o�n�f�i�g�u�r�a�t�i�o�n�
�
�r�u�l�e�s�.�j�s�o�n� � � � � � � � � �R�u�l�e�s� �l�i�b�r�a�r�y� �f�o�r� �p�o�l�i�c�y� �i�n�j�e�c�t�i�o�n�
�
����
�
�
�
�#�#� �I�n�s�t�a�l�l�a�t�i�o�n�
�
�
�
�#�#�#� �F�r�o�m� �N�P�M�
�
�
�
����b�a�s�h�
�
�n�p�m� �i�n�s�t�a�l�l� �-�g� �d�i�v�y�a�-�d�r�i�s�h�t�i�-�a�g�e�n�t�
�
����
�
�
�
�#�#�#� �L�o�c�a�l� �D�e�v�e�l�o�p�m�e�n�t�
�
�
�
����b�a�s�h�
�
�g�i�t� �c�l�o�n�e� �<�y�o�u�r�-�r�e�p�o�-�u�r�l�>�
�
�c�d� �d�i�v�y�a�-�d�r�i�s�h�t�i�-�a�g�e�n�t�
�
�n�p�m� �i�n�s�t�a�l�l�
�
�n�p�m� �l�i�n�k�
�
����
�
�
�
�#�#� �U�s�a�g�e�
�
�
�
�#�#�#� �R�u�n� �a� �f�u�l�l� �a�u�d�i�t�
�
�
�
����b�a�s�h�
�
�d�i�v�y�a� �s�c�a�n� �.�
�
����
�
�
�
�#�#�#� �S�c�a�n� �a�n�o�t�h�e�r� �r�e�p�o�s�i�t�o�r�y�
�
�
�
����b�a�s�h�
�
�d�i�v�y�a� �s�c�a�n� �.�.�/�m�y�-�p�r�o�j�e�c�t�
�
����
�
�
�
�#�#�#� �G�e�n�e�r�a�t�e� �a� �r�e�p�o�r�t� �f�r�o�m� �t�h�e� �l�a�t�e�s�t� �s�c�a�n�
�
�
�
����b�a�s�h�
�
�d�i�v�y�a� �r�e�p�o�r�t�
�
����
�
�
�
�#�#�#� �R�u�n� �t�h�e� �a�u�t�o�-�f�i�x� �e�n�g�i�n�e�
�
�
�
����b�a�s�h�
�
�d�i�v�y�a� �f�i�x�
�
����
�
�
�
�#�#�#� �C�r�e�a�t�e� �A�I�-�a�s�s�i�s�t�e�d� �c�o�d�e� �f�r�o�m� �r�u�l�e�s�
�
�
�
����b�a�s�h�
�
�d�i�v�y�a� �c�r�e�a�t�e� �a�u�t�h� �-�-�f�e�a�t�u�r�e� �"�l�o�g�i�n� �p�a�g�e�"�
�
����
�
�
�
�#�#� �C�L�I� �C�o�m�m�a�n�d�s�
�
�
�
�|� �C�o�m�m�a�n�d� � �|� �D�e�s�c�r�i�p�t�i�o�n� � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � �|�
�
�|� �-�-�-�-�-�-�-�-� �|� �-�-�-�-�-�-�-�-�-�-�-�-�-�-�-�-�-�-�-�-�-�-�-�-�-�-�-�-�-�-�-�-�-�-�-�-�-�-�-�-�-�-�-� �|�
�
�|� ��s�c�a�n�� � � �|� �R�u�n� �t�h�e� �f�u�l�l� �a�u�d�i�t� �p�i�p�e�l�i�n�e� � � � � � � � � � � � � � � � � �|�
�
�|� ��r�e�p�o�r�t�� �|� �P�r�i�n�t� �t�h�e� �l�a�t�e�s�t� �a�u�d�i�t� �r�e�p�o�r�t� � � � � � � � � � � � � � � �|�
�
�|� ��f�i�x�� � � � �|� �A�p�p�l�y� �s�u�p�p�o�r�t�e�d� �a�u�t�o�-�f�i�x�e�s� � � � � � � � � � � � � � � � � � �|�
�
�|� ��c�r�e�a�t�e�� �|� �G�e�n�e�r�a�t�e� �A�I�-�a�s�s�i�s�t�e�d� �c�o�d�e� �w�i�t�h� �p�o�l�i�c�y� �r�u�l�e�s� �|�
�
�|� ��c�l�e�a�n�� � �|� �C�l�e�a�r� �m�e�m�o�r�y� �a�n�d� �g�e�n�e�r�a�t�e�d� �a�r�t�i�f�a�c�t�s� � � � � � � � �|�
�
�
�
�#�#� �E�x�a�m�p�l�e� �W�o�r�k�f�l�o�w�
�
�
�
����t�e�x�t�
�
�U�s�e�r� �c�o�m�m�a�n�d�
�
� � ��!
�
�C�L�I�
�
� � ��!
�
�E�n�g�i�n�e�
�
� � ��!
�
�F�i�l�e� �R�e�a�d�e�r�
�
� � ��!
�
�S�e�c�u�r�i�t�y� �/� �L�o�g�i�c� �/� �P�e�r�f�o�r�m�a�n�c�e� �S�c�a�n�n�e�r�s�
�
� � ��!
�
�U�I� �S�k�e�l�e�t�o�n� �G�e�n�e�r�a�t�o�r�
�
� � ��!
�
�R�e�p�o�r�t� �G�e�n�e�r�a�t�o�r�
�
� � ��!
�
�G�i�t� �M�a�n�a�g�e�r�
�
����
�
�
�
�#�#� �G�i�t�H�u�b� �A�c�t�i�o�n�s�
�
�
�
�D�i�v�y�a� �D�r�i�s�h�t�i� �G�i�t�A�g�e�n�t� �c�a�n� �r�u�n� �a�u�t�o�m�a�t�i�c�a�l�l�y� �o�n�:�
�
�
�
�� ��p�u�s�h��
�
�� ��p�u�l�l�_�r�e�q�u�e�s�t��
�
�
�
�T�y�p�i�c�a�l� �a�u�t�o�m�a�t�i�o�n� �f�l�o�w�:�
�
�
�
�1�.� �C�h�e�c�k�o�u�t� �r�e�p�o�s�i�t�o�r�y�
�
�2�.� �I�n�s�t�a�l�l� �d�e�p�e�n�d�e�n�c�i�e�s�
�
�3�.� �R�u�n� �t�h�e� �a�u�d�i�t� �p�i�p�e�l�i�n�e�
�
�4�.� �G�e�n�e�r�a�t�e� �r�e�p�o�r�t� �f�i�l�e�s�
�
�5�.� �U�p�l�o�a�d� �a�r�t�i�f�a�c�t�s� �o�r� �c�r�e�a�t�e� �P�R� �c�o�m�m�e�n�t�s�
�
�
�
�#�#� �C�o�n�f�i�g�u�r�a�t�i�o�n�
�
�
�
�#�#�#� ��a�g�e�n�t�.�y�a�m�l��
�
�
�
�T�h�i�s� �f�i�l�e� �c�o�n�t�r�o�l�s� �p�i�p�e�l�i�n�e� �b�e�h�a�v�i�o�r�,� �e�x�e�c�u�t�i�o�n� �o�r�d�e�r�,� �a�n�d� �o�u�t�p�u�t� �s�e�t�t�i�n�g�s�.�
�
�
�
�#�#�#� ��r�u�l�e�s�.�j�s�o�n��
�
�
�
�T�h�i�s� �f�i�l�e� �s�t�o�r�e�s� �b�e�s�t�-�p�r�a�c�t�i�c�e� �r�u�l�e�s� �a�n�d� �p�o�l�i�c�y� �p�r�o�m�p�t�s� �u�s�e�d� �d�u�r�i�n�g� �A�I�-�a�s�s�i�s�t�e�d� �c�o�d�e� �g�e�n�e�r�a�t�i�o�n�.�
�
�
�
�#�#� �B�e�n�e�f�i�t�s�
�
�
�
�� �D�e�t�e�c�t�s� �i�s�s�u�e�s� �b�e�f�o�r�e� �d�e�p�l�o�y�m�e�n�t�
�
�� �I�m�p�r�o�v�e�s� �c�o�d�e� �q�u�a�l�i�t�y� �a�n�d� �m�a�i�n�t�a�i�n�a�b�i�l�i�t�y�
�
�� �R�e�d�u�c�e�s� �s�e�c�u�r�i�t�y� �a�n�d� �p�e�r�f�o�r�m�a�n�c�e� �r�i�s�k�
�
�� �S�u�p�p�o�r�t�s� �a�u�t�o�m�a�t�e�d� �r�e�v�i�e�w� �w�o�r�k�f�l�o�w�s�
�
�� �F�i�t�s� �l�o�c�a�l�,� �G�i�t�H�u�b�,� �a�n�d� �C�I�/�C�D� �e�n�v�i�r�o�n�m�e�n�t�s�
�
�
�
�#�#� �O�u�t�p�u�t� �S�a�f�e�t�y�
�
�
�
�T�h�e� �s�y�s�t�e�m� �i�s� �d�e�s�i�g�n�e�d� �t�o� �k�e�e�p� �a�u�d�i�t� �o�u�t�p�u�t� �r�e�a�d�a�b�l�e� �a�n�d� �p�r�i�v�a�c�y�-�c�o�n�s�c�i�o�u�s�:�
�
�
�
�� �a�b�s�o�l�u�t�e� �p�a�t�h�s� �a�r�e� �r�e�d�u�c�e�d� �t�o� �r�e�l�a�t�i�v�e� �p�a�t�h�s�
�
�� �s�e�n�s�i�t�i�v�e� �v�a�l�u�e�s� �a�r�e� �m�a�s�k�e�d�
�
�� �r�e�p�e�a�t�e�d� �i�s�s�u�e�s� �a�r�e� �d�e�d�u�p�l�i�c�a�t�e�d�
�
�� �f�i�n�d�i�n�g�s� �a�r�e� �p�r�i�o�r�i�t�i�z�e�d� �b�y� �s�e�v�e�r�i�t�y�
�
�
�
�#�#� �R�o�a�d�m�a�p�
�
�
�
�� �D�e�e�p�e�r� �t�a�i�n�t� �a�n�d� �d�a�t�a�-�f�l�o�w� �a�n�a�l�y�s�i�s�
�
�� �M�o�r�e� �a�d�v�a�n�c�e�d� �a�u�t�o�-�f�i�x� �g�e�n�e�r�a�t�i�o�n�
�
�� �G�i�t�H�u�b� �A�p�p� �i�n�t�e�g�r�a�t�i�o�n�
�
�� �D�a�s�h�b�o�a�r�d� �U�I� �f�o�r� �r�e�p�o�r�t�s� �a�n�d� �h�i�s�t�o�r�y�
�
�� �M�u�l�t�i�-�r�e�p�o�s�i�t�o�r�y� �s�u�p�p�o�r�t�
�
�
�
�#�#� �C�o�n�t�r�i�b�u�t�i�n�g�
�
�
�
�C�o�n�t�r�i�b�u�t�i�o�n�s� �a�r�e� �w�e�l�c�o�m�e�.� �P�l�e�a�s�e� �o�p�e�n� �a�n� �i�s�s�u�e� �o�r� �s�u�b�m�i�t� �a� �p�u�l�l� �r�e�q�u�e�s�t� �w�i�t�h� �c�l�e�a�r� �d�e�t�a�i�l�s� �a�b�o�u�t� �y�o�u�r� �c�h�a�n�g�e�.�
�
�
�
�#�#� �L�i�c�e�n�s�e�
�
�
�
�M�I�T�
�
�
�
�-�-�-�
�
�
�
���D�i�v�y�a� �D�r�i�s�h�t�i� �G�i�t�A�g�e�n�t��� �i�s� �b�u�i�l�t� �t�o� �h�e�l�p� �t�e�a�m�s� �s�h�i�p� �s�a�f�e�r�,� �c�l�e�a�n�e�r�,� �a�n�d� �m�o�r�e� �r�e�l�i�a�b�l�e� �c�o�d�e�.�
�
�
