{"id":14064741,"url":"https://github.com/Foat/kickstart.dotfiles","last_synced_at":"2025-07-29T18:33:54.879Z","repository":{"id":252897246,"uuid":"804865727","full_name":"Foat/kickstart.dotfiles","owner":"Foat","description":"A starting point for your .dotfiles configuration management","archived":false,"fork":false,"pushed_at":"2024-05-23T14:31:01.000Z","size":11,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"prime","last_synced_at":"2024-08-13T07:07:27.194Z","etag":null,"topics":["bash","commandline","dotfile","dotfiles","dotfiles-automation","dotfiles-linux","dotfiles-macos","dotfiles-management","dotfiles-manager","environment-variables","git","kickstart","manager","template"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Foat.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-23T12:26:30.000Z","updated_at":"2024-08-13T07:07:29.246Z","dependencies_parsed_at":"2024-08-13T07:07:28.674Z","dependency_job_id":"b57b4c0d-7e35-44c9-8bfa-aa0015d966d0","html_url":"https://github.com/Foat/kickstart.dotfiles","commit_stats":null,"previous_names":["foat/kickstart.dotfiles"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Foat%2Fkickstart.dotfiles","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Foat%2Fkickstart.dotfiles/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Foat%2Fkickstart.dotfiles/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Foat%2Fkickstart.dotfiles/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Foat","download_url":"https://codeload.github.com/Foat/kickstart.dotfiles/tar.gz/refs/heads/prime","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228040833,"owners_count":17860211,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bash","commandline","dotfile","dotfiles","dotfiles-automation","dotfiles-linux","dotfiles-macos","dotfiles-management","dotfiles-manager","environment-variables","git","kickstart","manager","template"],"created_at":"2024-08-13T07:04:03.045Z","updated_at":"2024-12-04T03:31:26.315Z","avatar_url":"https://github.com/Foat.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# kickstart.dotfiles (kdf)\n\n## Overview\n\nThis project provides a Python script to manage your `.dotfiles` efficiently. It includes features to clone separate Git repositories, link static files and folders, handle templates with environment variables, and check for differences between generated and template files. The script supports dry-run functionality and backs up existing files before creating new ones.\n\n## Features\n\n- Clone specified Git repositories to desired directories.\n- Create symlinks for static files and folders.\n- Generate and link files from templates, supporting environment variable substitution.\n- Check for differences between generated files and templates (uses `diff` CLI, which should be installed on most systems already).\n- Backup existing files before overwriting.\n- Support for dry-run mode to preview actions without making changes.\n\n## Configuration\n\nThe script uses a JSON configuration file to specify the dotfiles setup. Here is an example `config.json`:\n\n```json\n{\n  \"dotfiles\": {\n    \"content\": \"./example/content/\",\n    \"generated\": \"./example/generated@linux/\"\n  },\n  \"clone\": {\n    \".ssh\": {\n      \"url\": \"https://github.com/nvim-lua/kickstart.nvim\",\n      \"path\": \"./example/home@linux/.config/nvim\"\n    }\n  },\n  \"links\": {\n    \".config/yazi\": \"./example/home@linux/.config/yazi\",\n    \".zshrc_add@linux\": \"./example/home@linux/.zshrc_add\"\n  },\n  \"templates\": {\n    \".zshrc.temp\": \"./example/home@linux/.zshrc\",\n    \".config/rclone/rclone.conf.temp\": \"./example/home@linux/.config/rclone/rclone.conf\"\n  },\n  \"env\": [\n    \"TEMP_EXAMPLE_ENV\"\n  ],\n  \"env_base64\": [\n    \"TEMP_RCLONE_HOME\"\n  ]\n}\n```\n\n## Usage\n\n### First steps\n\n- Fork or clone this repo to have your own copy that you can modify.\n- Put your configuration and .dotfiles there.\n\n### Running the Script\n\nTo use kdf, run the script with the desired options:\n\n```bash\npython kdf.py --config path/to/config.json [--dry-run] [--check-templates]\n```\n\n### Options\n\n- `--config`: Path to the configuration JSON file (required).\n- `--dry-run`: Perform a dry run, showing what actions would be taken without making any changes.\n- `--check-templates`: Check if the generated templates differ from the existing files without regenerating templates.\n\n### Example\n\nPerform a dry run with the specified configuration:\n\n```bash\npython kdf.py --config config.json --dry-run\n```\n\nCheck for differences between generated and template files:\n\n```bash\npython kdf.py --config config.json --check-templates\n```\n\nRun the provided `example`, it will generate files in the `example` folder:\n\n```bash\ngit clone https://github.com/Foat/kickstart.dotfiles.git\ncd kickstart.dotfiles\n./example/run.sh --config ./example/config@linux.json\n```\n\nSee `./example/run.sh` for some comments on how to use environment variables.\n\n### Template Variables\nIn template files, replaceable variables are presented like `{{ TEMP_BW_SESSION }}`. The program will replace these variables with the corresponding environment variable values. You can provide variables in base64 format (used for multiline variables); use the `env_base64` config parameter for that. They will be decoded before replacing the template variables.\n\n## Requirements\n\n- Python 3.8+\n- No external dependencies are required.\n\n## Naming\n\nInspired by https://github.com/nvim-lua/kickstart.nvim project.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFoat%2Fkickstart.dotfiles","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FFoat%2Fkickstart.dotfiles","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFoat%2Fkickstart.dotfiles/lists"}