{"id":20606828,"url":"https://github.com/jochumdev/pmxc","last_synced_at":"2025-04-15T02:44:59.442Z","repository":{"id":67627066,"uuid":"135080382","full_name":"jochumdev/pmxc","owner":"jochumdev","description":"Python API Client for Proxmox VE","archived":false,"fork":false,"pushed_at":"2021-08-18T06:34:02.000Z","size":60,"stargazers_count":20,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-15T02:44:54.587Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jochumdev.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-05-27T20:46:16.000Z","updated_at":"2025-03-10T01:00:26.000Z","dependencies_parsed_at":null,"dependency_job_id":"77034cfc-eebd-438b-b78d-7b7d8d122a8b","html_url":"https://github.com/jochumdev/pmxc","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jochumdev%2Fpmxc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jochumdev%2Fpmxc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jochumdev%2Fpmxc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jochumdev%2Fpmxc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jochumdev","download_url":"https://codeload.github.com/jochumdev/pmxc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248997087,"owners_count":21195797,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-16T09:34:48.838Z","updated_at":"2025-04-15T02:44:59.437Z","avatar_url":"https://github.com/jochumdev.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"pmxc - a console client for Proxmox VE\n======================================\n\nInstall on Debian\n+++++++++++++++++\n\n.. code:: bash\n\n    sudo apt install python3-click python3-pip python3-uvloop python3-aiohttp python3-texttable python3-aiodns python3-chardet virt-viewer\n    sudo pip3 install \"\u003cpath-to-the-git-dir\u003e[performance,uvloop]\"\n\nUsing pmxc\n++++++++++\n\nFirst create a remote:\n\nWARNING: If you store the password it will be saved in plain text in ~/.config/pmxc/config.json\n\n.. code:: bash\n\n    $ pmxc remote add pve01 https://pve01.fk.jochum.dev:8006 root@pam\n\nNow you can list VM's/Container's:\n\n.. code:: bash\n\n    $ pmxc list pve01\n\nOr open a the virt-viewer on VM id **100**:\n\n.. code:: bash\n\n    $ pmxc spice pve01 100\n\nIf you add a serial console to a Linux VM (maybe also FreeBSD) you can enter it too now:\n\nThis requires that you setup the console first inside the VM: https://www.rogerirwin.co.nz/open-source/enabling-a-serial-port-console/\n\n.. code:: bash\n\n    $ pmxc enter pve01 100\n\nOr open a shell on the container **101**:\n\nYou can exit it with: CTRL+A q\n\n.. code:: bash\n\n    $ pmxc enter pve01 101\n\nHave fun with pmxc i hope you like it as i do :)\n\nThe `pmxc enter` command now supports piping commands:\n\nYou need to enable automatic login to serial console as described here: https://wiki.gentoo.org/wiki/Automatic_login_to_virtual_console\n\n.. code:: bash\n\n    $ echo \"/bin/bash -c 'touch /test; echo bla'\" | pmxc enter pve01 101\n\nWindows\n++++++++++++++++++\n\n2018 I had success with babun on Windows, now lacking a Windows box and babun discontinued I have no clue.\nIt should work unter cygwin though.\n\nThe version parts\n+++++++++++++++++\n\nThe first 2 numbers are the Promox VE API pmxc targets to, the next 2 are the pmxc version.\n\nLike 5.2.0.1 means its target for Promox VE 5.2 and its the first release (0.1) for that.\n\nDevelopment\n+++++++++++\n\nLinux\n-----\n\nCreate a venv:\n\n.. code:: bash\n    $ sudo apt install virtualenv\n    $ virtualenv -p /usr/bin/python3 venv\n    $ source venv/bin/activate\n\n\n.. code:: bash\n\n    $ venv/bin/pip install -e \".[development,performance,uvloop]\"\n\nNow use ./venv/bin/pmxc instead of just plain `pmxc`\n\nLicense\n+++++++\n\nMIT\n\n\nCopyright\n+++++++++\n\nCopyright (c) 2018-2020 by René Jochum\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjochumdev%2Fpmxc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjochumdev%2Fpmxc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjochumdev%2Fpmxc/lists"}