Skip to content

Commit 6063897

Browse files
committed
feat: Improved README
1 parent 43c2b18 commit 6063897

File tree

1 file changed

+27
-77
lines changed

1 file changed

+27
-77
lines changed

README.md

Lines changed: 27 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**Stop manually setting up your development environment. Define it once, replicate it everywhere.**
44

5-
Codify is a command-line tool that brings the power of Infrastructure as Code (IaC) to your local development machine. Manage system settings, install packages, configure tools, and automate your entire setup using a simple, declarative configuration file—just like you manage your infrastructure with Terraform.
5+
Codify is a command-line tool that brings the power of Infrastructure as Code (IaC) to your local development machine. Manage system settings, install packages, configure tools, and automate your setup using a simple, declarative configuration file. It's like Terraform but for your local machine.
66

77
<p align="center">
88
<a href="https://codifycli.com">Website</a> •
@@ -24,7 +24,6 @@ Every developer has been there:
2424
- **New machine?** Spend hours reinstalling and configuring everything
2525
- **Team onboarding?** Send them a scattered wiki page of manual installation steps
2626
- **Multiple machines?** Keep them in sync manually
27-
- **What's installed?** No clear record of your development environment
2827
- **Configuration drift?** Your laptop works differently than your colleague's
2928

3029
## The Solution
@@ -47,19 +46,19 @@ With Codify, your entire development environment is defined in a single `codify.
4746
```
4847

4948
Now you can:
50-
- **See what changes** before applying them with `codify plan`
51-
- **Apply changes** automatically with `codify apply`
52-
- **Version control** your environment setup
53-
- **Share configurations** with your team
54-
- **Replicate setups** across multiple machines in minutes
49+
- **See what changes** before applying them with `codify plan`
50+
- **Apply changes** automatically with `codify apply`
51+
- **Version control** your environment setup
52+
- **Share configurations** with your team
53+
- **Replicate setups** across multiple machines in minutes
5554

5655
## Key Features
5756

58-
### 🎯 **Declarative Configuration**
57+
### **Declarative Configuration**
5958
Define your entire development environment in a single, readable configuration file. No more shell scripts or scattered installation instructions.
6059

61-
### 🔍 **Plan Before You Apply**
62-
Like Terraform, Codify shows you exactly what changes will be made before executing them. No surprises.
60+
### **Plan Before You Apply**
61+
Like Terraform, Codify shows you exactly what changes will be made before executing them.
6362

6463
```bash
6564
$ codify plan
@@ -87,8 +86,8 @@ Do you want to apply the above changes?
8786
No
8887
```
8988

90-
### 📥 **Import Your Current Setup**
91-
Already have a configured machine? Generate a Codify configuration from your existing setup in seconds:
89+
### **Import Your Current Setup**
90+
Already have a configured machine? Generate a Codify configuration from your existing setup:
9291

9392
```bash
9493
$ codify init
@@ -109,7 +108,7 @@ Use <space> to select and <return> to submit.
109108
Use <a> to select all items and <d> to de-select all items.
110109
```
111110
112-
### 🔌 **Extensible Plugin System**
111+
### **Extensible Plugin System**
113112
Out-of-the-box support for:
114113
- **Homebrew** (formulae and casks)
115114
- **VS Code** (extensions and settings)
@@ -118,20 +117,19 @@ Out-of-the-box support for:
118117
- **Git** configuration
119118
- And [many more](https://docs.codifycli.com/plugins)...
120119
121-
Don't see what you need? Create your own plugin in minutes.
120+
Don't see what you need? [Create your own plugin](https://codifycli.com/docs/plugins).
122121
123-
### 🌐 **Web-Based Editor**
124-
Edit your configuration in a beautiful web interface at [dashboard.codifycli.com](https://dashboard.codifycli.com):
125-
- 🎨 Intuitive UI with auto-completion
126-
- 🔄 Real-time validation
127-
- ☁️ Cloud sync across devices
128-
- 🤝 Share configurations with your team
122+
### **Web-Based Editor**
123+
Edit your configuration in a web interface at [dashboard.codifycli.com](https://dashboard.codifycli.com):
124+
- Intuitive UI with auto-completion
125+
- Real-time validation
126+
- Cloud sync across devices
127+
- Share configurations with your team
129128
130-
### 🔒 **Safe & Secure**
129+
### **Safe & Secure**
131130
- Preview all changes before applying
132-
- Sudo password prompts only when needed
133-
- Secure mode for extra protection
134-
- Open source and Apache 2.0 licensed
131+
- Both the CLI tool and default plugin are open source and Apache 2.0 licensed
132+
- Requests your password each time elevated privileges (sudo) is required.
135133
136134
## Quick Start
137135
@@ -175,14 +173,6 @@ codify plan
175173
codify apply
176174
```
177175
178-
### Pro Tip: Use the Web Editor
179-
180-
Visit [dashboard.codifycli.com](https://dashboard.codifycli.com) for a guided, visual way to build your configuration with:
181-
- Auto-complete for all available packages
182-
- Real-time validation
183-
- Cloud storage and sync
184-
- Shareable configurations
185-
186176
## Common Commands
187177
188178
| Command | Description |
@@ -198,26 +188,6 @@ Visit [dashboard.codifycli.com](https://dashboard.codifycli.com) for a guided, v
198188
199189
Run `codify --help` for a complete list of commands and options.
200190
201-
## Real-World Use Cases
202-
203-
### **Individual Developers**
204-
- Keep multiple machines (work laptop, personal laptop, desktop) in sync
205-
- Quickly recover from system reinstalls or upgrades
206-
- Document your development environment as code
207-
- Try out new tools without the hassle of installing them
208-
209-
### **Development Teams**
210-
- Onboard new developers in minutes instead of days
211-
- Ensure everyone has the same development environment
212-
- Share team configurations via Git or the [Codify editor](https://dashboard.codifycli.com)
213-
- Reduce "works on my machine" problems
214-
215-
### **Organizations**
216-
- Standardize development environments across teams
217-
- Maintain compliance with required tools and versions
218-
- Reduce IT support burden for developer setup
219-
- Break down barriers between teams and departments
220-
221191
## Example Configurations
222192
223193
### Full-Stack JavaScript Developer
@@ -298,41 +268,21 @@ Run `codify --help` for a complete list of commands and options.
298268
]
299269
```
300270
301-
## Why Codify vs. Alternatives?
302-
303-
| Feature | Codify | Homebrew Bundle | Shell Scripts | Manual Setup |
304-
|----------------------------------|:------:|:---------------:|:-------------:|:------------:|
305-
| Declarative configuration | ✅ | ✅ | ❌ | ❌ |
306-
| Plan before apply | ✅ | ❌ | ❌ | ❌ |
307-
| Import existing setup | ✅ | ❌ | ❌ | ❌ |
308-
| Multi-format support | ✅ | ❌ | ❌ | ❌ |
309-
| Web-based editor | ✅ | ❌ | ❌ | ❌ |
310-
| Cross-tool management | ✅ | ❌ | ⚠️ | ❌ |
311-
| Extensible plugins | ✅ | ❌ | ⚠️ | ❌ |
312-
| Cloud sync | ✅ | ❌ | ❌ | ❌ |
313-
| Update detection | ✅ | ✅ | ❌ | ❌ |
314-
315271
## Frequently Asked Questions
316272
317273
**Q: Does Codify work on Linux and Windows?**
318274
A: Codify currently supports macOS and Linux. Windows support works via WSL.
319275
320-
**Q: Can I use Codify with my existing Homebrew setup?**
321-
A: Yes! Run `codify init` to import your existing packages into a Codify configuration.
322-
323-
**Q: Is my sudo password stored?**
324-
A: No. Codify only caches your password in memory during a session and prompts when needed. Use `--secure` mode for extra protection.
325-
326276
**Q: How is this different from Ansible/Chef/Puppet?**
327277
A: Those tools are designed for server configuration management. Codify is purpose-built for local development environments with a focus on simplicity and developer experience.
328278
329279
## Community & Support
330280
331-
- 📚 **Documentation**: [docs.codifycli.com](https://docs.codifycli.com)
332-
- 🐛 **Issues**: [GitHub Issues](https://github.com/codifycli/codify/issues)
333-
- 💬 **Default Plugin**: [GitHub Default Plugin](https://github.com/codifycli/default-plugin)
334-
- 🌐 **Website**: [codifycli.com](https://codifycli.com)
335-
- ☁️ **Editor**: [dashboard.codifycli.com](https://dashboard.codifycli.com)
281+
- **Documentation**: [docs.codifycli.com](https://docs.codifycli.com)
282+
- **Issues**: [GitHub Issues](https://github.com/codifycli/codify/issues)
283+
- **Default Plugin**: [GitHub Default Plugin](https://github.com/codifycli/default-plugin)
284+
- **Website**: [codifycli.com](https://codifycli.com)
285+
- **Editor**: [dashboard.codifycli.com](https://dashboard.codifycli.com)
336286
337287
## Contributing
338288

0 commit comments

Comments
 (0)