You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+30-11Lines changed: 30 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Penify CLI
2
2
3
-
Penify CLI is a command-line tool for managing Git hooks and generating documentation. It provides functionality to install and uninstall Git post-commit hooks, generate documentation for files or folders, and perform Git commits with automated message generation.
3
+
Penify CLI is a command-line tool for managing Git hooks, generating documentation, and streamlining the development workflow. It provides functionality to install and uninstall Git post-commit hooks, generate documentation for files or folders, perform Git commits with automated message generation, and manage authentication.
4
4
5
5
## Installation
6
6
@@ -14,16 +14,25 @@ pip install penify-cli
14
14
15
15
Penify CLI provides several subcommands for different functionalities:
16
16
17
+
### Login
18
+
19
+
To log in and obtain an API token:
20
+
21
+
```bash
22
+
penify-cli login
23
+
```
24
+
25
+
This command will open a browser window for authentication. After successful login, the API key will be saved locally for future use.
-`-t, --token`: Your API token for authentication. If not provided, the tool will look for the `PENIFY_API_TOKEN` environment variable.
48
56
-`-fl, --file_path`: Path to a specific file for which to generate documentation.
49
57
-`-cf, --complete_folder_path`: Path to a folder for which to generate documentation for all files.
50
58
-`-gf, --git_folder_path`: Path to a Git repository to generate documentation for modified files. Defaults to the current directory.
51
59
52
-
Note: If you want to automate API Documentation, Architecture Documentation, Code Documentation, Pull Request Documentation and need a demo. Send message in our support channel [Discord](https://discord.gg/wqrc8JeV)
53
-
54
60
### Commit Code
55
61
56
62
To commit code with an automatically generated commit message:
-`-gf, --git_folder_path`: Path to the Git repository. Defaults to the current directory.
63
-
-`-t, --token`: Your API token for authentication. If not provided, the tool will look for the `PENIFY_API_TOKEN` environment variable.
64
69
-`-m, --message`: Optional commit message. If not provided, a default message will be used.
65
70
-`-e, --terminal`: Set to "True" to open the terminal for editing the commit message. Defaults to "False".
66
71
72
+
## Authentication
73
+
74
+
Penify CLI uses an API token for authentication. The token is obtained and used in the following priority:
75
+
76
+
1. Command-line argument: `-t` or `--token`
77
+
2. Environment variable: `PENIFY_API_TOKEN`
78
+
3. Stored credentials: `~/.penify` file (created after successful login)
79
+
80
+
If no token is available, you'll be prompted to log in or provide a token.
81
+
67
82
## Environment Variables
68
83
69
-
-`PENIFY_API_TOKEN`: You can set this environment variable with your API token to avoid passing it as an argument each time. Here is the [tutorial](https://docs.penify.dev/docs/Creating-API-Keys-in-Penify.html) on setting env variables
84
+
-`PENIFY_API_TOKEN`: You can set this environment variable with your API token to avoid passing it as an argument each time.
70
85
71
86
## Development
72
87
@@ -96,4 +111,8 @@ Contributions are welcome! Please feel free to submit a Pull Request.
96
111
97
112
## Issues
98
113
99
-
If you encounter any problems or have suggestions, please file an issue on the [GitHub repository](https://github.com/SingularityX-ai/penify-cli/issues).
114
+
If you encounter any problems or have suggestions, please file an issue on the [GitHub repository](https://github.com/SingularityX-ai/penify-cli/issues).
115
+
116
+
## Support
117
+
118
+
For automated API Documentation, Architecture Documentation, Code Documentation, Pull Request Documentation, or if you need a demo, please join our [Discord support channel](https://discord.gg/wqrc8JeV).
0 commit comments