turbowarp-cli


Nameturbowarp-cli JSON
Version 1.0.0 PyPI version JSON
download
home_pageNone
SummaryRun scratch projects in your terminal using turbowarp scaffolding
upload_time2025-09-08 20:04:36
maintainerNone
docs_urlNone
authorfaretek1
requires_pythonNone
licenseNone
keywords goboscript scratch turbowarp
VCS
bugtrack_url
requirements playwright rich
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # tw-cli

> Run scratch projects in the terminal

> [!WARNING]
> These install instructions may not be enough if you are
> running a linux distro not directly supported by playright, e.g. arch.
> Make sure you can open chromium with playright with `playwright open` 
> before trying to use tw-cli

- Uses playwright and turbowarp scaffolding
- Supports the turbowarp debugger's log, warn, error and breakpoint blocks.

## Installation

`pip install turbowarp-cli`

<details>
<summary>Bleeding edge:</summary>
1. git clone this repo
2. `pip install -e .`
3. to update, use `git pull`
</details>

## Usage

`twcli run <Project path>`

It only works on project files.

---

If you want to automatically supply inputs to `ask and wait` blocks, use the -i command:

`twcli run .\Project.sb3 -i "hi" "there`

This provides the arguments:
- `hi`
- `there`

If you want to disable headless mode (to see the browser), use `-H`:

`twcli run .\Project.sb3 -i "hi" "there" -H`

If the exit code is 1, a Runtime error will always be raised.
The only way to exit with code 1 is with a breakpoint block.
Otherwise, the program will exit with code 0 when it naturally stops.

If you want to use your own 'error codes'

1. Use the error block. This will print in red but not exit the program
2. Use the breakpoint block

This is ^^ intentional design to keep things simpler.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "turbowarp-cli",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "goboscript, scratch, turbowarp",
    "author": "faretek1",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/2b/d6/5b23718c8d226e20a29a1d7098707a5b2aefd1c3223f64645084fbe0d9e5/turbowarp_cli-1.0.0.tar.gz",
    "platform": null,
    "description": "# tw-cli\n\n> Run scratch projects in the terminal\n\n> [!WARNING]\n> These install instructions may not be enough if you are\n> running a linux distro not directly supported by playright, e.g. arch.\n> Make sure you can open chromium with playright with `playwright open` \n> before trying to use tw-cli\n\n- Uses playwright and turbowarp scaffolding\n- Supports the turbowarp debugger's log, warn, error and breakpoint blocks.\n\n## Installation\n\n`pip install turbowarp-cli`\n\n<details>\n<summary>Bleeding edge:</summary>\n1. git clone this repo\n2. `pip install -e .`\n3. to update, use `git pull`\n</details>\n\n## Usage\n\n`twcli run <Project path>`\n\nIt only works on project files.\n\n---\n\nIf you want to automatically supply inputs to `ask and wait` blocks, use the -i command:\n\n`twcli run .\\Project.sb3 -i \"hi\" \"there`\n\nThis provides the arguments:\n- `hi`\n- `there`\n\nIf you want to disable headless mode (to see the browser), use `-H`:\n\n`twcli run .\\Project.sb3 -i \"hi\" \"there\" -H`\n\nIf the exit code is 1, a Runtime error will always be raised.\nThe only way to exit with code 1 is with a breakpoint block.\nOtherwise, the program will exit with code 0 when it naturally stops.\n\nIf you want to use your own 'error codes'\n\n1. Use the error block. This will print in red but not exit the program\n2. Use the breakpoint block\n\nThis is ^^ intentional design to keep things simpler.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Run scratch projects in your terminal using turbowarp scaffolding",
    "version": "1.0.0",
    "project_urls": {
        "Documentation": "https://github.com/inflated-goboscript/tw-cli",
        "Homepage": "https://github.com/inflated-goboscript/tw-cli",
        "Source": "https://github.com/inflated-goboscript/tw-cli"
    },
    "split_keywords": [
        "goboscript",
        " scratch",
        " turbowarp"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "a3e65901333ce196d9bfc7f1f040bcb498a006658b33f26ac217a77ae96566a8",
                "md5": "74e70ed75e6d736fdcccbb5c342d5962",
                "sha256": "b60c99fe38d440b6236b0e9277c4b30b9e870bd4b45e8cc799e27696d7e3d827"
            },
            "downloads": -1,
            "filename": "turbowarp_cli-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "74e70ed75e6d736fdcccbb5c342d5962",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 2380247,
            "upload_time": "2025-09-08T20:04:34",
            "upload_time_iso_8601": "2025-09-08T20:04:34.640397Z",
            "url": "https://files.pythonhosted.org/packages/a3/e6/5901333ce196d9bfc7f1f040bcb498a006658b33f26ac217a77ae96566a8/turbowarp_cli-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "2bd65b23718c8d226e20a29a1d7098707a5b2aefd1c3223f64645084fbe0d9e5",
                "md5": "61f55191fc1ebc8b0c1a6e12e08516e4",
                "sha256": "146ae592a7049d9ae2351b2279a54eb84d4d05a1cb1a212203328bc3fce3b478"
            },
            "downloads": -1,
            "filename": "turbowarp_cli-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "61f55191fc1ebc8b0c1a6e12e08516e4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 2376992,
            "upload_time": "2025-09-08T20:04:36",
            "upload_time_iso_8601": "2025-09-08T20:04:36.195992Z",
            "url": "https://files.pythonhosted.org/packages/2b/d6/5b23718c8d226e20a29a1d7098707a5b2aefd1c3223f64645084fbe0d9e5/turbowarp_cli-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-09-08 20:04:36",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "inflated-goboscript",
    "github_project": "tw-cli",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "playwright",
            "specs": [
                [
                    "~=",
                    "1.55.0"
                ]
            ]
        },
        {
            "name": "rich",
            "specs": [
                [
                    "~=",
                    "14.1.0"
                ]
            ]
        }
    ],
    "lcname": "turbowarp-cli"
}
        
Elapsed time: 1.97796s