Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vincentkoc/natilius
🐚 Automated one-click developer and engineering environment setup on Mac OS
https://github.com/vincentkoc/natilius
development-environment homebrew macos
Last synced: 8 days ago
JSON representation
🐚 Automated one-click developer and engineering environment setup on Mac OS
- Host: GitHub
- URL: https://github.com/vincentkoc/natilius
- Owner: vincentkoc
- License: gpl-3.0
- Created: 2023-02-02T04:59:08.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-21T05:35:56.000Z (15 days ago)
- Last Synced: 2024-10-22T18:39:52.615Z (14 days ago)
- Topics: development-environment, homebrew, macos
- Language: Shell
- Homepage:
- Size: 668 KB
- Stars: 40
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Natilius 🐚
Automated One-Click Mac Developer Environment Setup
Features •
Installation •
Quick Start •
Usage •
Customization •
Contributing •
License
Natilius is a powerful, customizable, and easy-to-use tool that automates the setup of a complete Mac development environment. With just one click, it installs and configures essential developer tools, applications, and settings, saving you hours of manual setup time.
## Features
- 🚀 **One-Click Setup**: Get your Mac ready for development in minutes, not hours.
- 🛠 **Customizable**: Easily tailor the setup to your specific needs.
- 📦 **Comprehensive**: Installs and configures a wide range of development tools and applications.
- 🔒 **Secure**: Implements best practices for macOS security settings.
- 🔄 **Idempotent**: Safely run multiple times without side effects.
- 📊 **Modular**: Easily extend or modify functionality.
## Customization
Natilius is highly customizable. Edit the `.natiliusrc` file in your home directory to tailor the installation to your needs. You can:
- Choose which development environments to set up (e.g., Python, Node.js, Ruby)
- Select which applications to install
- Configure macOS preferences
- And much more!
## What Gets Installed?
Natilius can set up a complete development environment, including:
- Xcode Command Line Tools
- Homebrew and essential formulae
- Programming languages and version managers (e.g., Python, Node.js, Ruby)
- Developer tools (e.g., Git, Docker, Visual Studio Code)
- Productivity apps (e.g., Alfred, iTerm2)
- And much more!
Check the [full list of installed software](docs/installed-software.md) for details.
## Why Natilius?
- **Time-saving**: Set up your development environment in minutes, not hours or days.
- **Consistency**: Ensure all your Macs have the same setup, great for teams.
- **Best Practices**: Implements security and performance best practices out of the box.
- **Customizable**: Easily adapt to your specific needs and preferences.
- **Open Source**: Benefit from community contributions and transparency.
## How It Works
Natilius uses a modular approach to set up your Mac:
1. **System Update**: Ensures your Mac is up-to-date and installs necessary components like Xcode CLI tools.
2. **Security**: Implements best-practice security settings for macOS.
3. **Homebrew**: Installs Homebrew and manages package installations.
4. **Development Environments**: Sets up various language environments (Python, Node.js, Ruby, etc.).
5. **Applications**: Installs and configures both CLI and GUI applications.
6. **macOS Preferences**: Configures macOS settings for optimal development experience.
Each step is customizable and can be enabled or disabled as needed.
## Installation
To install Natilius, follow these steps:
1. Open Terminal on your Mac.
2. Run the following command to download and install Natilius:
```
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/vincentkoc/natilius/main/install.sh)"
```
3. Follow the on-screen prompts to complete the installation.
## Quick Start
After installing Natilius, you can quickly set up your Mac development environment:
1. Open Terminal.
2. Run the following command:
```
natilius setup
```
3. Natilius will guide you through the setup process, allowing you to choose which components to install and configure.
4. Sit back and relax while Natilius sets up your Mac!
## Usage
Natilius provides several commands to help you manage your development environment:
- `natilius setup`: Run the full setup process
- `natilius update`: Update Natilius to the latest version
- `natilius customize`: Open the configuration file for customization
- `natilius doctor`: Check your system for potential issues
- `natilius help`: Display help information and available commands
For more detailed usage instructions, run `natilius help` or check our [documentation](docs/usage.md).
## Contributing
We welcome contributions! Whether it's bug reports, feature requests, or code contributions, please feel free to contribute. See our [Contributing Guide](CONTRIBUTING.md) for more details on how to get started.
## License
Natilius is open-source software licensed under the GNU General Public License v3.0. See the [LICENSE](LICENSE) file for more details.
## Acknowledgments
Natilius stands on the shoulders of giants. We'd like to thank:
- [Homebrew](https://brew.sh/)
- [Oh My Zsh](https://ohmyz.sh/)
- And all the amazing open-source projects that make Natilius possible.
## Support
If you find Natilius useful, please consider starring the repository on GitHub. It helps others discover the project and motivates further development.
For issues, feature requests, or questions, please use the [GitHub Issues](https://github.com/vincentkoc/natilius/issues) page.
## Roadmap
- [ ] Add support for more development environments and applications
- [ ] Implement a GUI for easier customization
- [ ] Create a web-based configuration generator
- [ ] Add support for Linux distributions
---
Made with ❤️ by Vincent Koc