flk 0.6.3

A CLI tool for managing flake.nix devShell environments
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
//! # flk - A CLI for managing Nix flake development environments
//!
//! `flk` provides a user-friendly command-line interface for managing Nix flake-based
//! development environments. It abstracts away the complexity of manually editing
//! `flake.nix` files, offering simple commands for common tasks like adding packages,
//! managing environment variables, and creating custom shell commands.
//!
//! ## Architecture
//!
//! This binary crate is the CLI entry point. It uses [clap] for argument parsing and
//! dispatches to handler functions in the [`commands`] module. The core library
//! functionality (flake parsing, generation, utilities) lives in the `flk` library crate.
//!
//! ## Subcommands
//!
//! - `init` - Initialize a new flake environment with language-specific templates
//! - `add`/`remove` - Manage packages in the development environment
//! - `search`/`deep-search` - Search nixpkgs for available packages
//! - `command` - Manage custom shell commands
//! - `env` - Manage environment variables
//! - `lock` - Manage flake.lock backups and restoration
//! - `activate` - Enter the development shell
//! - `export` - Export configuration to Docker, Podman, or JSON
//! - `hook` - Generate shell integration hooks
//! - `direnv` - Manage direnv integration

use anyhow::Result;
use clap::{Parser, Subcommand};

mod commands;
mod nix;

use crate::commands::{
    activate, add, command, completions, direnv, env,
    export::{self, ExportType},
    hook::{self, HookShell},
    init, list, lock, migrate, profiles, remove, search, show, update,
};

#[derive(Parser)]
#[command(name = "flk")]
#[command(author = "AEduardo-dev")]
#[command(version)]
#[command(about = "A CLI tool for managing flake.nix devShell environments", long_about = None)]
struct Cli {
    #[command(subcommand)]
    command: Commands,
}

#[derive(Subcommand)]
enum Commands {
    /// Initialize a new flake.nix in the current directory
    Init {
        /// Project type (rust, python, node, go, or generic)
        #[arg(short, long)]
        template: Option<String>,

        /// Force overwrite if flake.nix already exists
        #[arg(short, long)]
        force: bool,

        /// Materialize the legacy in-repo driver (`.flk/{default,overlays}.nix`,
        /// `.flk/profiles/default.nix`) instead of the slim `flk.lib.mkProject` layout
        #[arg(long)]
        legacy: bool,
    },

    /// Search for packages in nixpkgs
    Search {
        /// Package name to search for
        query: String,

        /// Limit number of results
        #[arg(short, long, default_value_t = 10)]
        limit: usize,
    },

    /// Get detailed information about a specific package
    DeepSearch {
        /// Full package name
        package: String,
    },

    /// List the packages of the flake.nix
    List {
        /// Target profile to list packages from
        #[arg(short = 'p', long)]
        profile: Option<String>,
    },
    /// Show flake.nix content in pretty print format
    Show {},

    /// Add a package to the flake.nix
    Add {
        /// Package name to add
        package: String,

        /// Pin to a specific version
        #[arg(short, long)]
        version: Option<String>,

        /// Target profile to add the package to
        #[arg(short = 'p', long)]
        profile: Option<String>,
    },

    /// Remove a package from the flake.nix
    Remove {
        package: String,
        /// Target profile to remove the package from
        #[arg(short = 'p', long)]
        profile: Option<String>,
    },

    /// Update packages to latest version
    /// TODO: manage version pinning after implementing #7
    Update {
        /// Specific packages to update
        packages: Vec<String>,

        /// Show what would be updated without actually updating
        #[arg(short, long)]
        show: bool,
    },

    /// Manage custom commands in the dev shell
    Command {
        #[command(subcommand)]
        action: CommandAction,
        /// Target profile to manage
        #[arg(short = 'p', long)]
        profile: Option<String>,
    },
    /// Manage environment variables in the dev shell
    Env {
        #[command(subcommand)]
        action: EnvAction,
        /// Target profile to manage
        #[arg(short = 'p', long)]
        profile: Option<String>,
    },

    /// Manage flake.lock file
    Lock {
        #[command(subcommand)]
        action: LockAction,
    },

    /// Generate and install shell completions
    Completions {
        /// Install the completions automatically
        #[arg(long)]
        install: bool,

        /// Manually specify shell (if not auto-detected)
        #[arg(value_enum)]
        shell: Option<clap_complete::shells::Shell>,
    },

    /// Reload the current shell environment
    Activate {
        /// Target profile to activate
        #[arg(short = 'p', long)]
        profile: Option<String>,
    },

    /// Export flake configurations (Docker, JSON, etc.)
    Export {
        #[arg(short, long)]
        format: ExportType,
        /// Target profile to export
        #[arg(short = 'p', long)]
        profile: Option<String>,
    },

    /// Direnv integration
    Direnv {
        #[command(subcommand)]
        action: DirenvAction,
    },

    /// Hook for nix-shell compatibility
    Hook {
        #[arg(value_enum)]
        shell: HookShell,
    },

    /// Manage profiles
    Profile {
        #[command(subcommand)]
        action: ProfileAction,
    },

    /// Convert a legacy flk project to the slim `flk.lib.mkProject` layout
    Migrate,
}

#[derive(Subcommand)]
enum CommandAction {
    /// Add a custom command to the dev shell
    Add {
        /// Command name
        name: String,

        /// Command definition (bash code)
        #[arg(trailing_var_arg = true, allow_hyphen_values = true)]
        command: Vec<String>,

        /// Source from a file instead
        #[arg(short, long)]
        file: Option<String>,
    },
    /// Remove a custom command from the dev shell
    Remove {
        /// Command name to remove
        name: String,
    },
    /// List all custom commands
    List,
}

#[derive(Subcommand)]
enum EnvAction {
    /// Add an environment variable
    Add {
        /// Variable name
        name: String,
        /// Variable value
        value: String,
    },
    /// Remove an environment variable
    Remove {
        /// Variable name
        name: String,
    },
    /// List all environment variables
    List,
}
#[derive(Subcommand)]
enum LockAction {
    /// Show detailed lock file information
    Show,

    /// Show lock file backup history
    History,

    /// Restore lock file from a backup
    Restore {
        /// Backup timestamp or identifier (e.g., "2025-01-27_14-30-00" or "latest")
        backup: String,
    },
}
#[derive(Subcommand)]
enum DirenvAction {
    /// Create .envrc with flake activation
    Init,
    /// Add flake activation to existing .envrc
    Attach,
    /// Remove flake activation from .envrc
    Detach,
}
#[derive(Subcommand)]
enum ProfileAction {
    /// Create a new profile
    Add {
        /// Profile name
        name: String,
        /// Template to use (base, rust, python, node, go, generic)
        #[arg(short, long)]
        template: Option<String>,
        /// Force overwrite if profile already exists
        #[arg(short, long)]
        force: bool,
    },
    /// Remove an existing profile
    Remove {
        /// Profile name
        name: String,
    },
    /// List all profiles
    List,
    /// Set default profile
    SetDefault {
        /// Profile name
        profile: String,
    },
}

fn main() -> Result<()> {
    let cli = Cli::parse();

    match cli.command {
        Commands::Init {
            template,
            force,
            legacy,
        } => {
            init::run(template, force, legacy)?;
        }
        Commands::Search { query, limit } => {
            search::run_search(&query, limit)?;
        }
        Commands::DeepSearch { package } => {
            search::run_deep_search(&package)?;
        }
        Commands::List { profile } => {
            list::run_list(profile)?;
        }
        Commands::Show {} => {
            show::run_show()?;
        }
        Commands::Add {
            package,
            version,
            profile,
        } => {
            add::run_add(&package, version, profile)?;
        }
        Commands::Remove { package, profile } => {
            remove::run_remove(&package, profile)?;
        }
        Commands::Update { packages, show } => {
            update::run_update(packages, show)?;
        }
        Commands::Command { action, profile } => match action {
            CommandAction::Add {
                name,
                command,
                file,
            } => {
                let cmd = command.join(" ");
                command::run_add(&name, &cmd, file, profile)?;
            }
            CommandAction::Remove { name } => {
                command::run_remove(&name, profile)?;
            }
            CommandAction::List => {
                command::list(profile)?;
            }
        },
        Commands::Env { action, profile } => match action {
            EnvAction::Add { name, value } => {
                env::add(&name, &value, profile)?;
            }
            EnvAction::Remove { name } => {
                env::remove(&name, profile)?;
            }
            EnvAction::List => {
                env::list(profile)?;
            }
        },
        Commands::Lock { action } => match action {
            LockAction::Show => {
                lock::show()?;
            }
            LockAction::History => {
                lock::history()?;
            }
            LockAction::Restore { backup } => {
                lock::restore(&backup)?;
            }
        },
        Commands::Completions { install, shell } => {
            completions::handle_completions(install, shell)?;
        }
        Commands::Activate { profile } => {
            activate::run_activate(profile)?;
        }
        Commands::Export { format, profile } => {
            export::run_export(&format, profile)?;
        }
        Commands::Direnv { action } => match action {
            DirenvAction::Init => {
                direnv::direnv_init()?;
            }
            DirenvAction::Attach => {
                direnv::direnv_attach()?;
            }
            DirenvAction::Detach => {
                direnv::direnv_detach()?;
            }
        },
        Commands::Hook { shell } => {
            hook::run_hook(shell)?;
        }
        Commands::Profile { action } => match action {
            ProfileAction::Add {
                name,
                template,
                force,
            } => {
                profiles::run_add(name, template, force)?;
            }
            ProfileAction::Remove { name } => {
                profiles::run_remove(name)?;
            }
            ProfileAction::List => {
                profiles::run_list()?;
            }
            ProfileAction::SetDefault { profile } => {
                profiles::run_set_default(profile)?;
            }
        },
        Commands::Migrate => {
            migrate::run()?;
        }
    }

    Ok(())
}