You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27-77Lines changed: 27 additions & 77 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
**Stop manually setting up your development environment. Define it once, replicate it everywhere.**
4
4
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.
6
6
7
7
<palign="center">
8
8
<ahref="https://codifycli.com">Website</a> •
@@ -24,7 +24,6 @@ Every developer has been there:
24
24
-**New machine?** Spend hours reinstalling and configuring everything
25
25
-**Team onboarding?** Send them a scattered wiki page of manual installation steps
26
26
-**Multiple machines?** Keep them in sync manually
27
-
-**What's installed?** No clear record of your development environment
28
27
-**Configuration drift?** Your laptop works differently than your colleague's
29
28
30
29
## The Solution
@@ -47,19 +46,19 @@ With Codify, your entire development environment is defined in a single `codify.
47
46
```
48
47
49
48
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
55
54
56
55
## Key Features
57
56
58
-
### 🎯 **Declarative Configuration**
57
+
### **Declarative Configuration**
59
58
Define your entire development environment in a single, readable configuration file. No more shell scripts or scattered installation instructions.
60
59
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.
63
62
64
63
```bash
65
64
$ codify plan
@@ -87,8 +86,8 @@ Do you want to apply the above changes?
87
86
No
88
87
```
89
88
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:
92
91
93
92
```bash
94
93
$ codify init
@@ -109,7 +108,7 @@ Use <space> to select and <return> to submit.
109
108
Use <a> to selectall items and <d> to de-select all items.
110
109
```
111
110
112
-
### 🔌 **Extensible Plugin System**
111
+
### **Extensible Plugin System**
113
112
Out-of-the-box support for:
114
113
- **Homebrew** (formulae and casks)
115
114
- **VS Code** (extensions and settings)
@@ -118,20 +117,19 @@ Out-of-the-box support for:
118
117
- **Git** configuration
119
118
- And [many more](https://docs.codifycli.com/plugins)...
120
119
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).
122
121
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
129
128
130
-
### 🔒 **Safe & Secure**
129
+
### **Safe & Secure**
131
130
- 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.
135
133
136
134
## Quick Start
137
135
@@ -175,14 +173,6 @@ codify plan
175
173
codify apply
176
174
```
177
175
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
-
186
176
## Common Commands
187
177
188
178
| Command | Description |
@@ -198,26 +188,6 @@ Visit [dashboard.codifycli.com](https://dashboard.codifycli.com) for a guided, v
198
188
199
189
Run `codify --help` for a complete list of commands and options.
200
190
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
-
221
191
## Example Configurations
222
192
223
193
### Full-Stack JavaScript Developer
@@ -298,41 +268,21 @@ Run `codify --help` for a complete list of commands and options.
A: Codify currently supports macOS and Linux. Windows support works via WSL.
319
275
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
-
326
276
**Q: How is this different from Ansible/Chef/Puppet?**
327
277
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.
0 commit comments