lit-cli

The lit cli manages git submodules and/or hard linked file(s). The lit cli extends the git cli so that the commands supplied are indistinguishable. With interactive mode, you get percision control over what commands are supplied to each submodule and with a simple configuration file(TOML formatted) you can easily add submodules or hard link file(s) to various destinations within an application.

Install

• via curl

  curl https://raw.githubusercontent.com/ml27299/lit-cli/master/install.sh | sudo bash
  
  
  

Usage

lit --help

Update lit to the latest version

sudo lit update

Init

lit init

in the working directory of your project, this will create a git project(if it didnt already exist) and add ".litconfig" and ".gitignore" files to the project, if it doesnt already have it. It's not necessary to configure the .litconfig file for lit to work (lit will work right out of the box for any project already using git submodules), its just there so that you can easily add new submodules to an application.

.litconfig (TOML format)

Ex.

[submodule "{{name}}"]
	path = "{{path}}"
	url = "git@github.com:{{USER}}/{{REPO}}.git"
[link "some-descriptor"]
	dest = "src/some/folder"
	sources = ["source/path/to/some/folder/*", "source/path/to/some/file.txt", "!source/path/to/some/folder/exclude.txt"]

Build

lit build

Initializes(if .gitmodules exsists) and/or adds(if .litconfig exsists) git submodules to a project. The build command also links any files configurged for linking

Remove

lit remove name|path

Properly removes a submodule from a project based on the module's name or path

Interactive mode

lit --inter [command] [options]
lit [command] [options] --inter
lit [command] --inter [options]

Interactive mode is useful when different options need to be passed depending on the submodule Ex.

lit commt -am "update something" - this will send the message "update something" to all submodules and the main application

Sometimes you want to put different messages for different submodules, to accomplish this in lit run

lit --inter commit -am "update something" - this will stop at every submodule and pop a prompt like

Interactive mode for $SUBMODULE_PATH
Below is the command that will be supplied to $SUBMODULE_PATH, edit if not correct
> --message="upadate something" --all

Here you can edit the message > --message="update another something" --all

Specific submoldule

lit --submodule path|name [command] [options]
lit [command] [options] --submodule path|name
lit [command] --submodule path|name [options]

In lit you can throw any command to just one submodule using the --submodule flag Ex.

lit --submodule {{path}} commit -am "update"
The name provided in the .litconfig file can also be used lit --submodule {{name}} commit -am "update"

Note: If the .gitmodules file has a name, but .litconfig doesntm than the {{name}} wont work, it must be included in the .litconfig file

Link

lit link (runs after every pull)

Hard links files or file to a custom destination within the application (uses .litconfig). When a file is hard linked its linked file path is added to the .gitignore within your project, this is done so that there arent multiple copies of the same file within your application and to ensure when someone clones or pulls the repo, the files are still hard linked.

Lit adds these paths when you supply the commit or add command, so no need to worry about it

Touch

lit touch

Since you may be hard linking a whole folder to various parts of your application, it can be a pain if you had to add a file to the source directory then relink. lit touch allows you to create a file anywhere in your application and will check if the directory of that file is being placed in has any source linking directories, if it does, it will create the file in the source directory and link it to the intended path

Ex. lit touch ./src/some/path/newfile.txt

If .litconfig was configured to something like this

[link "some-descriptor"]
    dest = "src/some/path"
    sources = ["some/source/path/*"]

then newfile.txt will be created in "some/source/path" and hard linked to "./src/some/path"

Add

lit add --help

This command extends the git add command, but does it for all submodules and main application. All commands that work with git add work with lit add

Ex. lit add .

Commit

lit commit --help

This command extends the git commit command, but does it for all submodules and main application. All commands that work with git commit work with lit commit

Ex. lit commit -am "My first commit!"

Pull

lit pull --help

This command extends the git pull command, but does it for all submodules and main application. All commands that work with git pull work with lit pull

Ex. lit pull origin master

Push

lit push --help

This command extends the git push command, but does it for all submodules and main application. All commands that work with git pull work with lit push

Ex. lit push origin master

Merge

lit merge --help

This command extends the git merge command, but does it for all submodules and main application. All commands that work with git pull work with lit merge

Ex. lit merge dev

Rebase

lit rebase --help

This command extends the git rebase command, but does it for all submodules and main application. All commands that work with git rebase work with lit merge

Ex. lit merge dev

Checkout

lit checkout --help

This command extends the git checkout command, but does it for all submodules and main application. All commands that work with git pull work with lit chckout

Ex. lit checkout dev

Extending

If anyone would like me to extend the lit cli to include more git commands, please submit an issue or pull request