Command line tool for rapidly moving between projects and aliasing common development commands.
by DAYFA1R
Building this out because I want to streamline context switching on different projects, and standardize the tech-specific commands I run into generically-termed commands that can be configured on a per-project basis (eg. set up the commands once and never worry about it again). For example, running a compiled project and building the project from source is a pretty common ritual among a variety of languages/frameworks. If you are maintaining a Node.js app, maybe you use npm run start to boot up your app. On the other hand, maybe you are mainting a C++ application and are manually running an output file as ./someExecutable. Essentially, the purpose of this software is to define these commands once in a configuration file, and simply execute ov run.
Another objective of this program is to remove the redundancy of having to traverse your file system. If you are on a system where you have multiple projects relating to multiple organizations, some of which are for sandbox/demo purposes and others which are full fledged applications, you probably have some sort of semantic folder structure to keep things separate. That's cool and all, but as of late I've become conscious of how much cding and tab completion I'm doing to jump around my system throughout my day to day.
Two things I'd like to call out before what I can only anticipate as probable criticism:
-
Yes, you can define a series of variables or aliases in your profile to store everything this application does, and just shorthand all this stuff using them. But why not leave your shell settings clean and just have a decently baked application to handle it all instead?
-
While this may simplify things for newer developers, I by no means would suggest using this program as a replacement for actually learning/getting into the habit of using UNIX commands, or the native tools your framework or library ships with. This is intended to at best give back a few seconds here and there to people who have already mastered the commands this program intends to streamline.
- From the root of the repository, run
make
For development
- Run
bin/ovto start overlord
For actual use
cp bin/ovto any of the directories listed in$PATH- Run
ovto start overlord
Optional
- Run
make cleanto wipe out any generated files
- From the root of the repository, run
make tests - Run
bin/run_tests - Assuming that little build icon in the top of this README is green, nothing should have exploded...yet
Optional
- Run
make cleanto wipe out any generated files
Subject to change, but this section represents the spec that I wish to build ov in mind with.
Nothing special to see here, it's essentially the same as running git, or the help argument in most applications.
Initializes the current directory as a new overlord project and generates a .ov.yaml file. Will run the init helper if a .ov.yaml file is not already present in the directory.
-r: Reruns the init helper prepopulated by.ov.yaml
Returns a list of all the unique id's that were initializated during the ov init setup.
Run command on project regardless of current directory.
Executes whatever was provided as the build command during the init process. Can also be supplied in the format ov <unique-id> build if you want to build a project external to your current directory, without actually changing directories.
-r: Runs the project after build process is completed
Executes whatever was provided as the run command during the init process. Can also be supplied in the format ov <unique-id> run if you want to run a project external to your current directory, without actually changing directories.
Executes whatever was provided as the editor command during the init process.
- Yes, the name of this project is 100% inspired by Starcraft.
