{"id":20373096,"url":"https://github.com/gluons/confc","last_synced_at":"2025-07-14T05:35:14.144Z","repository":{"id":39104999,"uuid":"63830953","full_name":"gluons/ConfC","owner":"gluons","description":"🆕 Start new project with your default configs.","archived":false,"fork":false,"pushed_at":"2024-11-19T01:41:36.000Z","size":799,"stargazers_count":3,"open_issues_count":11,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-06T00:41:11.712Z","etag":null,"topics":["cli","clone","confc","config","configuration","copy","hacktoberfest"],"latest_commit_sha":null,"homepage":"https://git.io/confc","language":"TypeScript","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/gluons.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":"2016-07-21T02:41:10.000Z","updated_at":"2025-02-23T17:43:31.000Z","dependencies_parsed_at":"2025-01-15T05:44:17.041Z","dependency_job_id":"8ab76fc0-617c-4bca-854b-3b4d3946ae6f","html_url":"https://github.com/gluons/ConfC","commit_stats":{"total_commits":196,"total_committers":6,"mean_commits":"32.666666666666664","dds":"0.34693877551020413","last_synced_commit":"69d8bfe0bea7845c51c433f2a1fcb6bad7f78dea"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/gluons/ConfC","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gluons%2FConfC","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gluons%2FConfC/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gluons%2FConfC/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gluons%2FConfC/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gluons","download_url":"https://codeload.github.com/gluons/ConfC/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gluons%2FConfC/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265246013,"owners_count":23734109,"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":["cli","clone","confc","config","configuration","copy","hacktoberfest"],"created_at":"2024-11-15T01:16:31.307Z","updated_at":"2025-07-14T05:35:14.117Z","avatar_url":"https://github.com/gluons.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ConfC\n[![license](https://img.shields.io/github/license/gluons/ConfC.svg?style=flat-square)](./LICENSE)\n[![npm](https://img.shields.io/npm/v/confc.svg?style=flat-square)](https://www.npmjs.com/package/confc)\n[![npm](https://img.shields.io/npm/dt/confc.svg?style=flat-square)](https://www.npmjs.com/package/confc)\n[![Travis](https://img.shields.io/travis/gluons/ConfC.svg?style=flat-square)](https://travis-ci.org/gluons/ConfC)\n[![TSLint](https://img.shields.io/badge/TSLint-gluons-15757B.svg?style=flat-square)](https://github.com/gluons/tslint-config-gluons)\n[![Renovate](https://img.shields.io/badge/Renovate-enabled-brightgreen.svg?style=flat-square)](https://renovateapp.com/)\n\n**Config Clone** — 🆕 Start new project with your default configs.\n\nClone your default configuration files to current working directory.\n\n## Installation\n\n**[npm](https://www.npmjs.com/):**\n\n[![NPM](https://nodei.co/npm/confc.png?downloads=true\u0026downloadRank=true\u0026stars=true)](https://www.npmjs.com/package/confc)\n\n```bash\nnpm install -g confc\n```\n\n**[Yarn](https://yarnpkg.com/):**\n\n```bash\nyarn global add confc\n```\n\n## Configuration\n\nYou can configure **ConfC** via `.confcrc` file.  \nMore information about configuration file can be found from [rc](https://github.com/dominictarr/rc).\n\n### .confcrc\n - **path**  \n   Type: `String`  \n   Default: **$HOME** (Your **home** directory)\n\n   Path to directory that contain your default configuration files.\n\n - **files**  \n   Type: `String[]`  \n   Default: Files name in [files.yaml](./files.yaml)\n\n   List of target files name that you want to clone.\n\n   \u003e If you have your own configuration files and don't want to use files from [files.yaml](./files.yaml), just replace it with your files name by this option.\n\n - **overwrite**  \n   Type: `Boolean`  \n   Default: `false`\n   \n   Force to overwrite files if it exists.\n\n - **verbose**  \n   Type: `Boolean`  \n   Default: `false`\n\n   Display verbose information.\n\n## Command Line (Preferred)\n\n```\nUsage: confc [options] [filenames...]\n\nClone your default configuration files to current working directory.\n\nOptions:\n  --help, -h       Show help                                           [boolean]\n  --version, -V    Show version number                                 [boolean]\n  --path, -p       Path to configuration files         [string] [default: $HOME]\n  --overwrite, -f  Force to overwrite                 [boolean] [default: false]\n  --yes, -y        Say yes without inquiry                             [boolean]\n  --verbose, -v    Display more information           [boolean] [default: false]\n\nExamples:\n  confc                                    Clone default files from your home path to current working directory\n  confc .eslintrc.json .editorconfig       Clone .eslintrc.json and .editorconfig from your home path to current working directory\n  confc --path ./myConfigs/ .editorconfig  Clone .editorconfig from ./myConfigs/ directory to current working directory\n```\n\n## Node API\n\n### `confc([fileNames, [options]])`\nReturn: [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\n\nClone configuration files to current working directory.\n\n#### `fileNames`\nType: `String[]`  \nDefault: Files name in [files.yaml](./files.yaml)\n\nFiles name to clone.\n\n#### `options`\nType: `Object`\n\n**Options:**\n- `path`  \n  Type: `String`  \n  Default: **$HOME** (Your **home** directory)\n\n  Path to configuration files.\n\n- `cwd`  \n  Type: `String`  \n  Default: Current working directory\n\n  Current working directory.  \n  It's used to specify the destination of cloned files.\n\n- `overwrite`  \n  Type: `Boolean`  \n  Default: `false`\n\n  Force to overwrite.\n\n##### Example\n\n- No parameters\n  ```js\n  const confc = require('confc');\n  confc()\n    .then(() =\u003e {\n      console.log('Succeed.');\n    })\n    .catch(err =\u003e {\n      console.log('Fail.');\n      console.error(err);\n    })\n  ```\n\n- With `fileNames`\n  ```js\n  const confc = require('confc');\n  confc(['.editorconfig', '.eslintrc.json'])\n    .then(() =\u003e {\n      console.log('Succeed.');\n    })\n    .catch(err =\u003e {\n      console.log('Fail.');\n      console.error(err);\n    })\n  ```\n\n- With `fileNames` and `options`\n  ```js\n  const confc = require('confc');\n  confc(['.editorconfig', '.eslintrc.json'], {\n    path: './myConfigs',\n    cwd: './targetDir',\n    overwrite: true\n  })\n    .then(() =\u003e {\n      console.log('Succeed.');\n    })\n    .catch(err =\u003e {\n      console.log('Fail.');\n      console.error(err);\n    })\n  ```\n\n- With only `options`\n  ```js\n  const confc = require('confc');\n  confc({\n    path: './myConfigs',\n    cwd: './targetDir',\n    overwrite: true\n  })\n    .then(() =\u003e {\n      console.log('Succeed.');\n    })\n    .catch(err =\u003e {\n      console.log('Fail.');\n      console.error(err);\n    })\n  ```\n\n## Related\n\n- [ConfC.gem](https://github.com/gluons/ConfC.gem) - 🆕 Start new project with your default configs. (💎 Ruby version)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgluons%2Fconfc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgluons%2Fconfc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgluons%2Fconfc/lists"}