Crate kamino

source · [−]
Expand description

Crates.io docs.rs CI

kamino

kamino helps manage a bunch of git repo clones. Specifically, it helps when you are working on repos on multiple machines which which you keep in sync with the same remote server.

It tells you which repos aren’t in sync with the remote:

  • If there are uncommitted changes, in the working copy or the index (maybe you forgot to commit?)
  • If there are stashed changes (maybe you wanted to apply them?)
  • If there are local commits not on the remote (maybe you forgot to push?)
  • If the remote is ahead of local (maybe you forgot to pull?)
  • If the git hooks in .githooks (if present) match the ones in .git/hooks (maybe you forgot to install / update a hook? maybe you have an active hook that should go into the repo?). This only checks the working copy and ignores .sample files.

Binary

The binary program doesn’t actually fix any of the above conditions, because it doesn’t know what you want to do about it. It just tells you in case you want to do something. Note that to check local vs remote it performs a fetch.

kamino scans for git repos within the directory you provide. Currently, this is a shallow scan that only looks one layer deep.

License

Licensed under either of

  • Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
  • MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Structs

AheadBehind
Contains details about the state of a branch relative to the remote server.
AheadBehindError
Error type for check_ahead_behind().
Hook
Contains the name and state of a single git hook.
HookError
Error type for check_hooks().
StashedError
Error type for check_stashed().
UncommittedError
Error type for check_uncommitted().

Enums

AheadBehindIterError
Error type for the iterator returned from check_ahead_behind().
HookState
Indicates the state of a single git hook.

Functions

check_ahead_behind
Check if each local branch is ahead or behind the remote. Fetch from origin first to make sure upstream is accurate.
check_hooks
Check whether git hooks match up in .githooks and .git/hooks. Ignore files that end with .sample. For each hook found, give the filename and state of it.
check_stashed
Check if there are any stashed changes.
check_uncommitted
Check if there are any uncommitted local changes.