{"id":15063372,"url":"https://github.com/13point5/espy-cli","last_synced_at":"2025-04-10T10:51:11.625Z","repository":{"id":57426991,"uuid":"191286460","full_name":"13point5/espy-cli","owner":"13point5","description":"A Command Line application to manage your ESP-IDF projects with ease.","archived":false,"fork":false,"pushed_at":"2019-06-27T09:36:49.000Z","size":62,"stargazers_count":8,"open_issues_count":1,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-18T07:31:49.102Z","etag":null,"topics":["cli","esp-idf","esp32","esp8266","python3"],"latest_commit_sha":null,"homepage":"","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/13point5.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-06-11T03:23:49.000Z","updated_at":"2020-04-03T14:31:07.000Z","dependencies_parsed_at":"2022-09-19T06:51:11.096Z","dependency_job_id":null,"html_url":"https://github.com/13point5/espy-cli","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/13point5%2Fespy-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/13point5%2Fespy-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/13point5%2Fespy-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/13point5%2Fespy-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/13point5","download_url":"https://codeload.github.com/13point5/espy-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248203328,"owners_count":21064564,"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":["cli","esp-idf","esp32","esp8266","python3"],"created_at":"2024-09-24T23:55:45.245Z","updated_at":"2025-04-10T10:51:11.610Z","avatar_url":"https://github.com/13point5.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# espy-cli\nA Command Line application to manage your ESP-IDF projects with ease.\n\n# Installation\n```\npip install espy-cli\n```\n\u003e This assumes that python3 is the default python version in your system.\n\n# Features\n* Manage all your projects and change their configuration\n* Use multiple IDF versions without the need to update Environment variables and then logout or reboot\n* Change the IDF used in a project at any time\n\n### Note\n\u003e Initially you need to configure 1 path in the IDF_PATH environment variable, **only once**.\u003cbr\u003e\n\u003e Projects are called apps.\u003cbr\u003e\n\u003e Before creating an app make sure you have added atleast 1 IDF path.\u003cbr\u003e\n\u003e In case you forget espy will remind you ;)\n\n# Usage\n1. Managing IDFs\n    * Add a new IDF\n        ```\n        $ espy idf new -n idf1 -f /home/user/esp/esp-idf\n\n        Successfully added idf1 to config\n        ```\n\n    * Get all or specific IDF(s)\n        ```\n        $ espy idf get\n\n        +------+--------------------------------------+\n        | name | filepath                             |\n        +------+--------------------------------------+\n        | idf1 | /home/user/esp/esp-idf               |\n        | idf2 | /home/user/esp/esp-idf-v3.3-beta3    |\n        +------+--------------------------------------+\n        ```\n\n\n        ```\n        $ espy idf get -n idf1\n\n        +------+--------------------------------------+\n        | name | filepath                             |\n        +------+--------------------------------------+\n        | idf1 | /home/user/esp/esp-idf               |\n        +------+--------------------------------------+\n        ```\n\n    * Modify a specific IDF\n        ```\n        $ espy idf mod -n idf1\n\n        +------+--------------------------------------+\n        | name | filepath                             |\n        +------+--------------------------------------+\n        | idf1 | /home/user/esp/esp-idf-v3.3-beta3    |\n        +------+--------------------------------------+\n\n        Change the name? [y/N]: y\n        Enter the new name for the IDF: default\n\n        Change the path of the IDF? [y/N]: y\n        Enter the new path for the IDF: /home/user/esp/esp-idf\n\n        Note: If this IDF has been used in an app, modify them if needed.\n        Continue to modify IDF? [y/N]: y\n        Succesfully modified the IDF\n        ```\n\n    * Delete all or specific IDF(s)\n        ```\n        $ espy idf del\n\n        Delete all IDFs? [y/N]: y\n        Successfully deleted required IDF(s)\n        ```\n\n        ```\n        $ espy idf del -n idf1\n\n        Delete IDF: idf1 [y/N]: y\n        Successfully deleted required IDF(s)\n        ```\n\n2. Managing apps\n   * Create a new app\n      ```\n      $ espy app new -n hello_world -idf idf1\n      Project created!\n\n      $ tree hello_world/\n      hello_world/\n      ├── CMakelists.txt\n      ├── main\n      │   ├── CMakelists.txt\n      │   ├── component.mk\n      │   └── main.c\n      └── Makefile\n\n      1 directory, 5 files\n      ```\n\n   * Get all or specific App(s)\n      ```\n      $ espy app get\n\n      +-------------+----------------------------------------------+------+---------------------------+\n      | name        | filepath                                     | idf  | idfpath                   |\n      +-------------+----------------------------------------------+------+---------------------------+\n      | hello_world | /home/user/Documents/projects/hello_world    | idf1 | /home/user/esp/esp-idf    |\n      +-------------+----------------------------------------------+------+---------------------------+\n      ```\n\n   * Modify an App\n      ```\n      $ espy app mod -n hello_world\n\n      What do you wish to modify?\n      [1] Name\n      [2] IDF\n\n      Enter option number (0 for ALL): 0\n\n      Enter new name: bye\n      Change the name of the project? [y/N]: y\n\n      Name changed.\n\n      Enter new IDF's name: idf2\n      Change the IDF of the project? [y/N]: y\n\n      IDF changed.\n\n      Successfully modified app details!\n      ```\n\n3. View Config\n      ```\n      $ espy show\n\n      Config location: /home/user/.config/espy-cli/config.json\n\n      IDFs\n\n      +------+--------------------------------------+\n      | name | filepath                             |\n      +------+--------------------------------------+\n      | idf1 | /home/user/esp/esp-idf               |\n      | idf2 | /home/user/esp/esp-idf-v3.3-beta3    |\n      +------+--------------------------------------+\n\n      Apps\n\n      +-------------+----------------------------------------------+------+---------------------------+\n      | name        | filepath                                     | idf  | idfpath                   |\n      +-------------+----------------------------------------------+------+---------------------------+\n      | hello_world | /home/user/Documents/projects/hello_world    | idf1 | /home/user/esp/esp-idf    |\n      +-------------+----------------------------------------------+------+---------------------------+\n      ```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F13point5%2Fespy-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F13point5%2Fespy-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F13point5%2Fespy-cli/lists"}