https://github.com/jmg-duarte/nabu

Keep your work commited and your repository up-to-date!
https://github.com/jmg-duarte/nabu

git rust

Last synced: 2 months ago
JSON representation

Keep your work commited and your repository up-to-date!

• Host: GitHub
• URL: https://github.com/jmg-duarte/nabu
• Owner: jmg-duarte
• License: apache-2.0
• Created: 2022-03-01T22:02:06.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-06-17T11:37:33.000Z (over 2 years ago)
• Last Synced: 2024-10-14T18:50:54.074Z (3 months ago)
• Topics: git, rust
• Language: Rust
• Homepage:
• Size: 482 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# Nabu 𒀭𒀝

> Nabu was the patron god of scribes, literacy, and wisdom.

> He was also the inventor of writing, a divine scribe...

```bash

$ cargo install nabu

```

Nabu's job is to keep your work commited;

in other words, it brings [Dura](https://github.com/tkellogg/dura) to the foreground.

It watches over your files and when it detects changes,

Nabu will stage and commit them to your repository.

## Get started

*Watch over a directory.*

```bash

$ nabu watch 

```

*Watch over a directory and its children (recursively).*

```bash

$ nabu watch -r 

```

## Push on exit

To push on exit you need to declare the `--push-on-exit` flag and an authentication method

(i.e. `--ssh-agent` or `--ssh-key`).

### Using the SSH agent

Using the `ssh-agent` method is very simple, you simply need to ensure that the `ssh-agent` is running

and declare the `--ssh-agent` flag.

*Push on exit using the SSH agent.*

```bash

$ nabu watch --push-on-exit --ssh-agent .

```

### Using your SSH key

To use the SSH key you need to declare the `--ssh-key` pointing to the SSH key associated with your git account.

In the case your passphrase is not empty, you can use the `--ssh-passphrase` to declare it.

*Push on exit using the provided SSH key (assumes the passphrase is empty).*

```bash

$ nabu watch --push-on-exit --ssh-key "~/.ssh/id.rsa" .

```

*Push on exit using the provided SSH key & passphrase.*

```bash

$ nabu watch --push-on-exit --ssh-key "~/.ssh/id.rsa" --ssh-passphrase "very_secret_passphrase" .

```

#### License



Licensed under either of Apache License, Version

2.0 or MIT license at your option.








Unless you explicitly state otherwise, any contribution intentionally submitted

for inclusion in this project by you, as defined in the Apache-2.0 license,

shall be dual licensed as above, without any additional terms or conditions.