https://github.com/nikolainobadi/nnex
Utility to manage swift executables and streamline distribution with Homebrew
https://github.com/nikolainobadi/nnex
command-line-tool macos swift swiftdata swiftdata-example swiftpackage testing
Last synced: 27 days ago
JSON representation
Utility to manage swift executables and streamline distribution with Homebrew
- Host: GitHub
- URL: https://github.com/nikolainobadi/nnex
- Owner: nikolainobadi
- License: mit
- Created: 2025-03-19T21:53:40.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-01T00:43:07.000Z (about 1 year ago)
- Last Synced: 2025-04-01T01:31:31.621Z (about 1 year ago)
- Topics: command-line-tool, macos, swift, swiftdata, swiftdata-example, swiftpackage, testing
- Language: Swift
- Homepage:
- Size: 945 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nnex
**nnex** is a command-line tool that streamlines the distribution of Swift command-line executables via **Homebrew**.
With a single command, **nnex** handles it all:
- ✅ Build optimized universal binaries for ARM and Intel architectures.
- ✅ Strip symbols to reduce binary size.
- ✅ Create a new Homebrew tap if needed.
- ✅ Create a GitHub release and attach the binary asset.
- ✅ Generate and upload a Homebrew formula to your Homebrew tap.
Instead of manually managing taps and formulae, let **nnex** do the heavy lifting for you.
**nnex** also supports importing your own Homebrew taps to leverage existing setups.
**nnex** requires both **Homebrew** and the **GitHub CLI (gh)** to function properly. Please ensure they are installed and configured on your system before using **nnex** (you'll be prompted to install them if you use **nnex** without them).
If you're curious about some of the struggles I went through to get SwiftData to work in a standalone Swift Package and in a CI workflow, I wrote an article outlining my journey that you can [check out here.](https://medium.com/@nikolai.nobadi/integrating-swiftdata-into-standalone-swift-packages-6cbcb45e5893)
## Table of Contents
- [Installation](#installation)
- [Commands](#commands)
- [Brew Commands](#brew-commands)
- [Publish](#publish)
- [Config Commands](#config-commands)
- [Contributing](#contributing)
- [License](#license)
- [Acknowledgements](#acknowledgements)
## Installation
Install **nnex** with Homebrew
```bash
brew tap nikolainobadi/nntools
brew install nnex
```
Alternatively, you can install it directly:
```bash
brew install nikolainobadi/tap/nnex
```
## Commands
**nnex** utilizes three subcommands: `Brew`, `Build`, and `Config`.
- **Brew commands** are used to interact with Homebrew and GitHub
- **Build commands** handle local binary building
- **Config commands** are used to set preferences
The tool follows a clean architecture with separation of concerns between command parsing, business logic, and infrastructure.
## Brew Commands
### Publish
The `publish` command is the most important command in **nnex**. It allows you to build a binary, create a new GitHub release, upload the binary, and optionally publish a Homebrew formula. This command streamlines the entire process of distributing your executable.
#### Basic Usage:
```swift
nnex brew publish
```
This command runs in the current directory and prompts you for any missing information.
To streamline the command and skip interactive prompts, include version, notes/notes-file, and a commit-message in the command.
```bash
nnex brew publish --version 1.0.0 --notes-file MyReleaseNotes.md --commit-message "Updated the formula for MyCoolTool" --skip-tests
```
If a required option is not specified, `nnex` will prompt you to enter it interactively.
If both `--notes` and `--notes-file` are provided, the command will throw an error since they are mutually exclusive.
For more details and advanced usage, refer to the [Command Reference](./docs/COMMANDS.md).
## Config Commands
To configure where any new Homebrew taps are created:
```bash
nnex config set-list-path /path/to/tap/folder
```
To display the current tap list folder path:
```bash
nnex config show-list-path
```
To open the tap list folder in Finder:
```bash
nnex config open-list-folder
```
To set the default binary build type:
```bash
nnex config set-build-type release
```
## Contributing
Contributions are welcome! If you'd like to improve a command, add new integrations, or fix bugs:
1. Fork the repo
2. Create a new branch
3. Submit a PR with a clear description
Issues and suggestions are also welcome via [GitHub Issues](https://github.com/nikolainobadi/nnex/issues).
## Acknowledgements
### Third-Party Libraries
#### My Libraries
- [SwiftPickerKit](https://github.com/nikolainobadi/SwiftPickerKit) - Interactive command-line selection interfaces
- [NnGitKit](https://github.com/nikolainobadi/NnGitKit) - Git operations wrapper (GitShellKit)
- [NnShellKit](https://github.com/nikolainobadi/NnShellKit) - Shell command execution utilities
- [NnSwiftDataKit](https://github.com/nikolainobadi/NnSwiftDataKit) - SwiftData utilities and extensions
#### External Libraries
- [Swift Argument Parser](https://github.com/apple/swift-argument-parser) - Command-line argument parsing
- [Files](https://github.com/JohnSundell/Files) - File system operations
## License
`nnex` is available under the MIT license. See the [LICENSE](LICENSE) file for more information.