https://github.com/imlymei/foji
⚒ Forge your code in a new way
https://github.com/imlymei/foji
automation cli cloud-sync commands developer-tools local-first nodejs open-source productivity typescript
Last synced: 4 months ago
JSON representation
⚒ Forge your code in a new way
- Host: GitHub
- URL: https://github.com/imlymei/foji
- Owner: imLymei
- License: mit
- Created: 2024-05-22T23:07:56.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-04T20:46:14.000Z (over 1 year ago)
- Last Synced: 2024-12-09T18:03:09.096Z (about 1 year ago)
- Topics: automation, cli, cloud-sync, commands, developer-tools, local-first, nodejs, open-source, productivity, typescript
- Language: TypeScript
- Homepage:
- Size: 157 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Foji ⚒️
Foji is a powerful command-line interface (CLI) tool designed to streamline and automate long or repetitive commands in your daily workflow. With Foji, you can define and execute custom commands, integrate custom parameters, and simplify complex processes, reducing the need to repeatedly type lengthy commands.
## 🚀 Features
- [x] Run custom commands with flexible argument handling.
- [x] Supports options, conditional, and spread arguments for advanced customization.
- [x] Easily add, edit and remove commands in the CLI.
- [x] Sync configuration to the cloud.
## 📦 Installation
> [!IMPORTANT]
> Foji requires [Node.js](https://nodejs.org/) to be installed on your system. Make sure you have it installed before proceeding.
To install Foji, run the following command:
```bash
npm i foji -g
```
## 🚦 Usage
Foji stores your commands and configurations in its configuration file (`~/.config/foji.json`). You can access it using:
```bash
foji config
```
Or open it directly:
```bash
foji config -f
```
### Running a Command
To execute a saved `command`:
```bash
foji [command name] [...command args]
```
> [!TIP]
> If you don’t provide a valid command name, Foji will list all available commands, including default commands like `add`, `remove`, and `sync`, along with any custom commands you've added.
### Skipping an Argument
If you want to skip an optional argument, use the `_` symbol:
```bash
foji [command name] [arg1] _ [arg3]
```
## ⚙️ Configuration Management
Foji allows you to easily create and update your command configurations.
### Adding a New Command
To add a new command to the configuration:
```bash
foji add [command name] [command]
```
Supported argument types:
1. **Required Arguments**:
These arguments **must** be provided for the command to run.
```json
"command": "echo "
```
2. **Optional Arguments**:
These arguments **are not mandatory**. If not provided, they will be skipped.
```json
"command": "echo "
```
3. **Optional Arguments with Default Values**:
If not provided, a default value will be used.
```json
"command": "echo "
```
4. **Ternary Arguments**:
Works as a boolean argument, only checking whether it was passed.
```json
"command": "echo i want pizza of with "
```
5. **Spread Argument**:
Catches all the remaining arguments.
```json
"command": "echo [] {}"
```
Example of usage:
```bash
foji command "my arg one" one two three --my --options
```
The resulting final command would be:
```bash
echo [my arg one] {one two three --my --options}
```
> [!IMPORTANT]
> **Always** provide required arguments **before** any optional ones.
### Removing a Command
To remove a command:
```bash
foji remove [command name]
```
## 🌐 Cloud Sync
You can easily sync your configurations using cloud services.
> [!NOTE]
> Foji uses [Github CLI](https://cli.github.com/) to create, read and update your configuration gist.
### Upload Configuration
To upload your configuration to a gist (or create a new gist if one doesn’t exist):
```bash
foji upload
```
### Download Configuration
To download a configuration file from a gist:
```bash
foji download [gist url]
```
### Sync Configuration
To sync your local configuration with its URL:
```bash
foji sync
```
> [!CAUTION]
> Be careful when syncing from external sources. Always verify the origin of the gist to avoid overriding your custom commands.
## 🛠️ Development
If you want to contribute or customize Foji, follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/imLymei/foji.git
cd foji
```
2. Install dependencies:
```bash
npm install
```
3. Build the project:
```bash
npm run build:local
```
## 📜 Credits
This project makes use of several open-source libraries and tools. Special thanks to the following:
- [TypeScript](https://www.typescriptlang.org/) - Type-safe JavaScript.
- [Commander](https://www.npmjs.com/package/commander) - CLI framework.
- [@inquirer/prompts](https://www.npmjs.com/package/@inquirer/prompts) - Command-line prompts.
- [semantic-release](https://www.npmjs.com/package/semantic-release) - Automates versioning and package publishing.
- [fast-levenshtein](https://www.npmjs.com/package/fast-levenshtein) - Fast string distance algorithm.
## 📄 License
Foji is licensed under the MIT License.
See the [LICENSE](https://github.com/imLymei/foji/blob/master/LICENSE) file for more information.