https://github.com/uppercod/cli-bone
https://github.com/uppercod/cli-bone
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/uppercod/cli-bone
- Owner: UpperCod
- Created: 2018-09-21T00:30:38.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-09-29T17:10:35.000Z (over 7 years ago)
- Last Synced: 2025-04-10T03:58:40.966Z (about 1 year ago)
- Language: JavaScript
- Size: 12.7 KB
- Stars: 2
- Watchers: 0
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# cli-bone
This **CLI**, allows you to copy the contents of repositories **GIT** on your local machine, to be used as a template so you can generate a dynamic cloning based on what **Bone** manages to collect tanks to [**prompts**](https://github.com/terkelg/prompts).
## Installation
```
npm install -g cli-bone
```
## bone
```
bone owner/name --dist my-folder
```
> If dist is not defined, Bone will insert the content in the execution directory.
## Opción `-u | --update`
Update the local repository.
```
bone owner/name -u --dist my-folder
```
## Opción `-r | --remove`
It will delete the local repository.
```
bone owner/name -r
```
## Opción `-c | --clone`
It allows to use a local source for cloning, avoiding the download from the git repository, it is useful to test the result of the template before loading it for example to github
```
bone owner/name -c -d my-copy
```
## Template options
### bone.config.js
If your template folder has a `bone.config.js` file, you can generate an instance of [**prompts**](https://github.com/terkelg/prompts), to capture parameters to be used in the copy to be generated by Bone.
```js
export default {
description: "my first directory template",
questions: [
{
type: "text",
name: "value",
message: "project's name?"
}
],
onSubmit(data) {
return data;
},
onCance() {
console.log("Noooo!");
}
};
```
## Example
### [uppercod/atomico-starter-component](https://github.com/uppercod/atomico-starter-component)
It allows to create a component based on Atomico.
```
bone uppercod/atomico-starter-component
```
### [uppercod/new-component](https://github.com/UpperCod/new-component)
It allows to create a component based of Atomico, Preact or Preact with Cssthis.
```
bone uppercod/new-component
```