# xbridge-cli
## Install
```bash
pip install xbridge-cli
```
NOTE: if you're looking at the repo before it's published, this won't work. Instead, you'll do this:
```bash
git clone https://github.com/xpring-eng/xbridge-cli.git
cd xbridge-cli
# install poetry
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -
poetry install
poetry shell
```
Install rippled and the xbridge witness.
rippled: https://xrpl.org/install-rippled.html
witness: https://github.com/seelabs/xbridge_witness
## Get started
```bash
export XCHAIN_CONFIG_DIR={filepath where you want your config files stored}
export RIPPLED_EXE={rippled exe filepath}
export WITNESSD_EXE={witnessd exe filepath}
./scripts/tutorial.sh
```
To stop the servers:
```bash
xbridge-cli server stop --all
```
## Use Commands
```bash
xbridge-cli --help
```
Each subcommand also has a `--help` flag, to tell you what fields you'll need.
Raw data
{
"_id": null,
"home_page": "https://github.com/xpring-eng/xbridge-cli",
"name": "xbridge-cli",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7.1,<4.0.0",
"maintainer_email": "",
"keywords": "xrp,xrpl,cryptocurrency",
"author": "Mayukha Vadari",
"author_email": "mvadari@ripple.com",
"download_url": "https://files.pythonhosted.org/packages/f7/e2/f4da1106c9675799aae12da5d6f728c964773ee8c8c4c4cabd72af42da1d/xbridge_cli-0.3.3.tar.gz",
"platform": null,
"description": "# xbridge-cli\n\n## Install\n\n```bash\npip install xbridge-cli\n```\n\nNOTE: if you're looking at the repo before it's published, this won't work. Instead, you'll do this:\n\n```bash\ngit clone https://github.com/xpring-eng/xbridge-cli.git\ncd xbridge-cli\n# install poetry\ncurl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -\npoetry install\npoetry shell\n```\n\nInstall rippled and the xbridge witness.\n\nrippled: https://xrpl.org/install-rippled.html\n\nwitness: https://github.com/seelabs/xbridge_witness\n\n## Get started\n\n```bash\nexport XCHAIN_CONFIG_DIR={filepath where you want your config files stored}\nexport RIPPLED_EXE={rippled exe filepath}\nexport WITNESSD_EXE={witnessd exe filepath}\n./scripts/tutorial.sh\n```\n\nTo stop the servers:\n\n```bash\nxbridge-cli server stop --all\n```\n\n## Use Commands\n\n```bash\nxbridge-cli --help\n```\n\nEach subcommand also has a `--help` flag, to tell you what fields you'll need.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A CLI that helps you set up an XRPL-XRPL bridge.",
"version": "0.3.3",
"project_urls": {
"Homepage": "https://github.com/xpring-eng/xbridge-cli",
"Repository": "https://github.com/xpring-eng/xbridge-cli"
},
"split_keywords": [
"xrp",
"xrpl",
"cryptocurrency"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9b955b1f807d0309ccbc12959fc5fd0bdce7797dede87df600ffa5cd01216272",
"md5": "9e8e63f203ca38dc43132febf0830edc",
"sha256": "cfddc8e89d1fbc969a9adcf1fa70b997f667b82f0f0d6b726dc2e314056fa0ec"
},
"downloads": -1,
"filename": "xbridge_cli-0.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9e8e63f203ca38dc43132febf0830edc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.1,<4.0.0",
"size": 49933,
"upload_time": "2023-10-10T19:37:22",
"upload_time_iso_8601": "2023-10-10T19:37:22.725606Z",
"url": "https://files.pythonhosted.org/packages/9b/95/5b1f807d0309ccbc12959fc5fd0bdce7797dede87df600ffa5cd01216272/xbridge_cli-0.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f7e2f4da1106c9675799aae12da5d6f728c964773ee8c8c4c4cabd72af42da1d",
"md5": "ab955a4263eddd6505ea6a354310940b",
"sha256": "2d869a0ef58a80dad448c0cac49dfacc4ac4d16167f6efef7b89f2a249e03d2c"
},
"downloads": -1,
"filename": "xbridge_cli-0.3.3.tar.gz",
"has_sig": false,
"md5_digest": "ab955a4263eddd6505ea6a354310940b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.1,<4.0.0",
"size": 33782,
"upload_time": "2023-10-10T19:37:29",
"upload_time_iso_8601": "2023-10-10T19:37:29.002530Z",
"url": "https://files.pythonhosted.org/packages/f7/e2/f4da1106c9675799aae12da5d6f728c964773ee8c8c4c4cabd72af42da1d/xbridge_cli-0.3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-10 19:37:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "xpring-eng",
"github_project": "xbridge-cli",
"github_not_found": true,
"lcname": "xbridge-cli"
}