git-assume 1.0.0

Add your description here

git-assume: A CLI Tool to Switch Your .netrc Configuration

git-assume helps you manage multiple .netrc configurations with ease.

Features

• List available .netrc profiles.
• Switch between different .netrc profiles.

Installation

pip install git-assume

Prerequisites

Create .netrc-longterm File

Create a .netrc-longterm file in your home directory. This file should be in INI file format, with each section representing a different .netrc profile.

Example .netrc-longterm:

[default]
machine = github.com
login = someone-foo
password = ghp_xxxxxxxxxx

[sub]
machine = github.com
login = someone-hoge
password = ghp_yyyyyyyyyy

CAUTION: Your Git password is stored in plain text. Ensure that the permissions of your .netrc-longterm file are restricted to you.

Backup Your .netrc File (Optional)

Since this tool overwrites your .netrc file, it's advisable to back it up before running the CLI.

cp ~/.netrc ~/.netrc-backup

Basic Usage

git-assume provides two subcommands: list and assume.

list: List Available Profiles

Use the list subcommand to display current profiles:

$ git-assume list
Profiles that exist in .netrc-longterm: /home/someone/.netrc-longterm
- default
- sub

Argument	Required	Default	Detail
--netrc-longterm	No	~/.netrc-longterm	Filepath to your .netrc-longterm.
--log-level	No	INFO	Log level. Choices: ["CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG", "NOTSET"]

assume: Switch Your .netrc Profile

Use the assume subcommand to switch profiles:

$ git-assume assume default
Are you sure you want to overwrite /home/someone/.netrc with profile `default`? [Y/n] Y
INFO - Successfully wrote to .netrc: /home/someone/.netrc

Argument	Required	Default	Detail
--netrc-longterm	No	~/.netrc-longterm	Filepath to your .netrc-longterm.
--netrc	No	~/.netrc	Filepath to your .netrc.
--log-level	No	INFO	Log level. Choices: ["CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG", "NOTSET"]
-y, --yes	No	False	If True, it overwrites .netrc file without any confirmation.

How It Works

When you run the assume subcommand, git-assume overwrites your .netrc file with the profile specified.

Example Workflow

$ git pull origin main
Username for 'https://github.com/xxx/yyy.git':
^C

$ git-assume list
Profiles that exist in .netrc-longterm: /home/someone/.netrc-longterm
- default
- sub

$ git-assume assume sub
Are you sure you want to overwrite /home/someone/.netrc with profile `default`? [Y/n] Y
INFO - Successfully wrote to .netrc: /home/someone/.netrc

$ git pull origin main
Already up to date.

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

License

The MIT License.