# xrpl-sidechain-cli
## Install
```bash
pip install xrpl-sidechain-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/sidechain-cli.git
cd sidechain-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
sidechain-cli server stop --all
```
## Use Commands
```bash
sidechain-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/sidechain-cli",
"name": "xrpl-sidechain-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/7e/aa/ca4aa67bf5c121bbee1f476fc8eb52623929a2f7a9745047d3c19feffa68/xrpl-sidechain-cli-1.0.0b4.tar.gz",
"platform": null,
"description": "# xrpl-sidechain-cli\n\n## Install\n\n```bash\npip install xrpl-sidechain-cli\n```\nNOTE: if you're looking at the repo before it's published, this won't work. Instead, you'll do this:\n```bash\ngit clone https://github.com/xpring-eng/sidechain-cli.git\ncd sidechain-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```bash\nsidechain-cli server stop --all\n```\n\n## Use Commands\n\n```bash\nsidechain-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 sidechain.",
"version": "1.0.0b4",
"split_keywords": [
"xrp",
"xrpl",
"cryptocurrency"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "f9d7a4c910270c8298dbcbc9e83e09e2",
"sha256": "a0305d88bcc3f671a84e9ae5165de93bd5c0ccdf006cf45a32d9243a6440808a"
},
"downloads": -1,
"filename": "xrpl_sidechain_cli-1.0.0b4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f9d7a4c910270c8298dbcbc9e83e09e2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.1,<4.0.0",
"size": 48004,
"upload_time": "2022-12-15T18:11:36",
"upload_time_iso_8601": "2022-12-15T18:11:36.449556Z",
"url": "https://files.pythonhosted.org/packages/6b/42/a7d4e0b7a48cabfa40110b1781d608833f92a59eec3065ec14781f13f4b6/xrpl_sidechain_cli-1.0.0b4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "c1fd8a621d591f18a7dedff8a41995ea",
"sha256": "3079b117df8febb2295364307b6aadc9da5e172b90e786cdd5593a79393f7149"
},
"downloads": -1,
"filename": "xrpl-sidechain-cli-1.0.0b4.tar.gz",
"has_sig": false,
"md5_digest": "c1fd8a621d591f18a7dedff8a41995ea",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.1,<4.0.0",
"size": 33179,
"upload_time": "2022-12-15T18:11:33",
"upload_time_iso_8601": "2022-12-15T18:11:33.674239Z",
"url": "https://files.pythonhosted.org/packages/7e/aa/ca4aa67bf5c121bbee1f476fc8eb52623929a2f7a9745047d3c19feffa68/xrpl-sidechain-cli-1.0.0b4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-15 18:11:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "xpring-eng",
"github_project": "sidechain-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "xrpl-sidechain-cli"
}
JSON
