Skip to content

docs: replace unused dotfiles_installCommand config option with dotfiles_install_command #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AlexTMjugador wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: replace unused dotfiles_installCommand config option with dotfiles_install_command #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f0ff86d
docs: replace unused `dotfiles_installCommand` config option with `do…
AlexTMjugador Aug 10, 2026
dba0368
docs(README): tweak default `dotfiles_install_command` value description
AlexTMjugador Aug 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Using **lazy.nvim**:
dotfiles_repository = "https://github.com/erichlf/dotfiles.git",
dotfiles_branch = "devcontainer-cli",
dotfiles_targetPath = "~/dotfiles",
dotfiles_installCommand = "install.sh",
dotfiles_install_command = "install.sh",
shell = "bash",
nvim_binary = "nvim",
log_level = "debug",
Expand Down Expand Up @@ -128,7 +128,7 @@ Call `require("devcontainer-cli").setup({ ... })` with any of the following opti
dotfiles_repository = "https://github.com/erichlf/dotfiles.git",
dotfiles_branch = "devcontainer-cli",
dotfiles_targetPath = "~/dotfiles",
dotfiles_installCommand = "install.sh",
dotfiles_install_command = nil, -- Let the Dev Container CLI pick a default

-- Shell used when executing commands
shell = "bash",
Expand Down Expand Up @@ -222,7 +222,7 @@ No. You can either keep Neovim on the host and use `:DevcontainerExec`, or conne
This plugin focuses on using the official Dev Container CLI and avoids imposing opinions. Similar projects include `esensar/nvim-dev-container` and `arnaupv/nvim-devcontainer-cli`; if you prefer a different model (e.g., host Neovim + remote LSP servers), compare approaches and pick what suits you.

**Where should I keep my dotfiles?**
Point `dotfiles_repository` to any repo. The plugin will clone that repo into the container and run your setup script (`dotfiles_installCommand`).
Point `dotfiles_repository` to any repo. The plugin will clone that repo into the container and run the configured setup script (`dotfiles_install_command`).

---

Expand Down
2 changes: 1 addition & 1 deletion lua/devcontainer-cli/config.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ local default_config = {
dotfiles_targetPath = "~/dotfiles",
-- command that's executed for installed the dependencies from the
-- setup_environment_repo
dotfiles_installCommand = "install.sh",
-- dotfiles_install_command = "install.sh", -- Let the devcontainer CLI choose
-- The number of columns to wrap text at
terminal_columns = 80,
-- The particular binary to use for connecting to in the devcontainer
Expand Down
Loading