Skip to content

Commit deda786

Browse files
committed
chore: added warning to cli readme.
1 parent 22acc46 commit deda786

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

packages/cli/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
Command-line interface for the providing terminal access to Xano development workflows.
44

5+
> !WARNING
6+
> WIP and BETA. While we aim to make this CLI robust and reliable partner in everyday Xano work,
7+
> several aspects might be fragile at this point. Use at own risk and we strongly suggest
8+
> exploring the possibilities in sandboxed, or a free Xano instance to avoid production environment disruptions.
9+
510
## Overview
611

712
The CLI package provides:
@@ -126,11 +131,12 @@ jobs:
126131
In order to actually use the CLI with proper git support it is advised to also define the `--output` flag when running the commands.
127132
This allows users to override the output and as a result keep a proper git history.
128133
The flow is as follows:
134+
129135
1. run the xano setup command
130136
2. make sure you have git installed on your machine
131137
3. run git init
132138
4. run a command e.g. `generate-repo --output lib` and then commit these changes to your desired branch
133-
5. create new branch (possibly name similarly as on your Xano) and run the `generate-repo --output lib` again. After a new commit and push you know have a fully git-enabled comparison of your two Xano branches.
139+
5. create new branch (possibly name similarly as on your Xano) and run the `generate-repo --output lib` again. After a new commit and push you know have a fully git-enabled comparison of your two Xano branches.
134140

135141
## License
136142

0 commit comments

Comments
 (0)