curasync 0.0.1-dev → 0.0.2
Sign up to get free protection for your applications and to get access to all the features.
- package/README.md +32 -9
- package/build/curasync +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
@@ -1,15 +1,38 @@
|
|
1
1
|
# curasync
|
2
2
|
|
3
|
-
|
3
|
+
This CLI tool helps you manage your cura configuration as a git repo. It is essentially a wrapper command around git that:
|
4
4
|
|
5
|
-
|
6
|
-
|
7
|
-
|
5
|
+
1. locates your cura configuration, .gitignores unnecessary files, and pushes them up to a blank repo (`curasync init <repo_url>`)
|
6
|
+
2. pushes your updated cura configuration up to the same repository with a commit message (`curasync push`)
|
7
|
+
3. lets someone clone your cura config (`curasync clone <repo_url>`)
|
8
|
+
4. lets them pull changes to the cura config (`curasync pull`)
|
8
9
|
|
9
|
-
|
10
|
+
Here's a guide to using `curasync`
|
10
11
|
|
11
|
-
|
12
|
-
bun run index.js
|
13
|
-
```
|
12
|
+
## Installing curasync
|
14
13
|
|
15
|
-
|
14
|
+
You can install this globally using npm or the equivalent command in your package manager:
|
15
|
+
|
16
|
+
`npm i -g curasync`
|
17
|
+
|
18
|
+
You can also run it as an executable directly:
|
19
|
+
|
20
|
+
`npx curasync`
|
21
|
+
|
22
|
+
## Pushing your configuration to a blank repo:
|
23
|
+
|
24
|
+
⚠️ Warning: If you are logged into Cura, do not push your config to a public repo just yet (TODO: strip tokens)
|
25
|
+
|
26
|
+
1. The first thing you want to do is to set up a blank repository. Here's a handy link if you're using GitHub: https://github.com/new. Make sure to leave 'Add a README file' unchecked since we do not want to initialize the repository on GitHub
|
27
|
+
2. Now that you have a blank repo, invoke `curasync init <repo_url>`. This pushes up your configuration to the repo.
|
28
|
+
3. Now you can invite collaborators to the repo, and tell them to invoke `npx curasync clone <repo_url>` to grab your cura configuration. If they have write access, they will be able to push changes to the repo too.
|
29
|
+
4. If you make more changes, do run `curasync push`, which prompts you to enter a commit message and pushes your changes to the repo.
|
30
|
+
|
31
|
+
## Pulling a cura configuration
|
32
|
+
|
33
|
+
Note: we do not have a way to merge two configurations just yet. If someone sends you a repo url, this will back up your existing configuration, and clone their repo entirely
|
34
|
+
|
35
|
+
1. Let's assume someone sent you a repo url containing delicious printer configuration files. You want to make sure you have cura and curasync installed.
|
36
|
+
2. Now, enter `curasync clone <repo_url>`. This backs up your existing config, and fetches the new config from git
|
37
|
+
3. That's pretty much it, try opening cura now. You should see the newly fetched configuration
|
38
|
+
4. If new changes are published, make sure to run `curasync pull` to get them.
|
package/build/curasync
CHANGED
Binary file
|