https://github.com/maremare/githubcommit
It's simply a tool to commit to GitHub.
https://github.com/maremare/githubcommit
csharp dotnet8 octokit-net
Last synced: 3 months ago
JSON representation
It's simply a tool to commit to GitHub.
- Host: GitHub
- URL: https://github.com/maremare/githubcommit
- Owner: MareMare
- License: mit
- Created: 2024-12-07T07:59:23.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-02-15T20:18:36.000Z (3 months ago)
- Last Synced: 2025-02-15T21:21:06.700Z (3 months ago)
- Topics: csharp, dotnet8, octokit-net
- Language: C#
- Homepage:
- Size: 57.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# GitHubCommit
It's simply a tool to commit to GitHub.
GitHubCommit is a straightforward command-line utility aimed at simplifying the process of adding or updating a single file in a GitHub repository. It enhances efficiency by offering easy-to-use commands and automating routine tasks associated with Git commits.
## Requirements
- [.NET Desktop Runtime 8.0](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) is required to run this tool.
- Ensure that the environment variable `GH_TOKEN` is set. This token is required for authenticating with GitHub to commit changes.
## Installation
1. Download the latest release from the [GitHub releases page](https://github.com/MareMare/GitHubCommit/releases).
2. Ensure that [.NET Desktop Runtime 8.0](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) is installed on your machine.
3. Extract the downloaded files to your preferred directory.
## Usage
```ps1
.\GitHubCommit.exe [OPTIONS]
```
### Arguments
| Argument | Description |
|----------------|--------------------------------------------------------------------|
| SourceFilePath | Specify the local path of the file to commit |
| TargetFilePath | Specify the path of the file to create or update in the repository |
### Options
| Option | Default | Description |
|------------------------|-------------|------------------------------------------------------------------|
| `-h, --help` | | Prints help information |
| `--repo ` | OWNER/REPO | Select another repository using the OWNER/REPO format |
| `--branch ` | main | Specify the branch where the file will be created or updated |
| `--message ` | | Specify the commit message for the file creation or update |
## Examples
Example of committing changes to the main branch:
```ps1
.\GitHubCommit.exe sampling_2024-12.csv data/sampling.csv --repo MareMare/GHCommitSandbox
```