{"id":19236423,"url":"https://github.com/infobyte/faraday-cli","last_synced_at":"2025-05-16T14:07:37.714Z","repository":{"id":39969052,"uuid":"288813025","full_name":"infobyte/faraday-cli","owner":"infobyte","description":"Faraday's Command Line Interface","archived":false,"fork":false,"pushed_at":"2025-01-14T21:04:58.000Z","size":9231,"stargazers_count":47,"open_issues_count":3,"forks_count":18,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-05-13T01:16:07.250Z","etag":null,"topics":["command-line","devops","devsecops","faraday","pentest","security-automation","security-pipeline","vulnerability-management","vulnerability-scanning"],"latest_commit_sha":null,"homepage":"https://faradaysec.com","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/infobyte.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG/0.1.0/01.first_version.md","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":"2020-08-19T18:55:09.000Z","updated_at":"2025-04-30T09:13:51.000Z","dependencies_parsed_at":"2024-06-19T06:14:57.744Z","dependency_job_id":"5c17bf1f-ce98-4d3e-bde3-5655fbdd57cf","html_url":"https://github.com/infobyte/faraday-cli","commit_stats":{"total_commits":244,"total_committers":13,"mean_commits":18.76923076923077,"dds":"0.34426229508196726","last_synced_commit":"d85fca64307f0ade347842a46d0ac4d1eacbaf05"},"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infobyte%2Ffaraday-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infobyte%2Ffaraday-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infobyte%2Ffaraday-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infobyte%2Ffaraday-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/infobyte","download_url":"https://codeload.github.com/infobyte/faraday-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254544146,"owners_count":22088807,"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":["command-line","devops","devsecops","faraday","pentest","security-automation","security-pipeline","vulnerability-management","vulnerability-scanning"],"created_at":"2024-11-09T16:20:34.015Z","updated_at":"2025-05-16T14:07:32.704Z","avatar_url":"https://github.com/infobyte.png","language":"Python","readme":"# Faraday on the terminal\nUse faraday directly from your favorite terminal\n\n![Example](./docs/docs/images/general.gif)\n\nfaraday-cli is the official client that make automating your security workflows, easier.\n\n## Install from pip\n\n```\npip install faraday-cli\n```\n\n## Install from source\n```shell script\ngit clone https://github.com/infobyte/faraday-cli.git\ncd faraday-cli\npip install .\n```\n\n## Documentation\n\nFor more info you can check our [documentation][doc]\n\n\n## Use it like a command\n\n### Login\n\nConfigure auth for farday-cli\n\n```shell script\n$ faraday-cli auth\n```\n![Example](./docs/docs/images/auth.gif)\n\n\n### Create a workspace\nWhen you create a workspace by default is selected as active, unless you use the \"-d\" flag\n```shell script\n$ faraday-cli workspace create some_name\n✔ Created workspace: some_name\n```\n\n### Select active workspace\n\n```shell script\n$ faraday-cli workspace select some_name\n✔ Selected workspace: some_name\n```\n\n### List workspaces\n\n```shell script\n$ faraday-cli list_ws\nNAME         HOSTS    SERVICES    VULNS  ACTIVE    PUBLIC    READONLY\n---------  -------  ----------  -------  --------  --------  ----------\nsome_name       14          13       39  True      False     False\n```\n\n### List hosts of a workspace\n\n```shell script\n$ faraday-cli host list\n  ID  IP           OS       HOSTNAMES          SERVICES  VULNS\n----  -----------  -------  ---------------  ----------  -------\n 574  127.0.0.1    unknown                            1  3\n 566  127.0.0.10   unknown                            1  3\n 569  127.0.0.11   unknown                            1  3\n 568  127.0.0.12   unknown                            1  3\n 570  127.0.0.13   unknown                            1  3\n 576  127.0.0.2    unknown                            1  3\n 565  127.0.0.3    unknown                            1  3\n 572  127.0.0.4    unknown                            1  3\n 573  127.0.0.5    unknown                            1  3\n 567  127.0.0.6    unknown                            1  3\n 571  127.0.0.7    unknown                            1  3\n 564  127.0.0.8    unknown                            1  3\n 575  127.0.0.9    unknown                            1  3\n 590  58.76.184.4  unknown  www.googlec.com           0  -\n```\n\n### Get host\n\n```shell script\n$ faraday-cli host get 574\n\n$ faraday-cli host get 574\nHost:\n  ID  IP         OS       HOSTNAMES    OWNER    OWNED      VULNS\n----  ---------  -------  -----------  -------  -------  -------\n 574  127.0.0.1  unknown               faraday  False          3\n\nServices:\n  ID  NAME    DESCRIPTION    PROTOCOL      PORT  VERSION    STATUS      VULNS\n----  ------  -------------  ----------  ------  ---------  --------  -------\n2638  ssh                    tcp             22  unknown    open            2\n\nVulnerabilities:\n   ID  NAME                                      SEVERITY    STATUS    CONFIRMED    TOOL\n-----  ----------------------------------------  ----------  --------  -----------  -------\n13509  SSH Weak Encryption Algorithms Supported  MED         opened    False        Openvas\n13510  SSH Weak MAC Algorithms Supported         LOW         opened    False        Openvas\n13511  TCP timestamps                            LOW         opened    False        Openvas\n```\n\n### Create hosts\n\n```shell script\n$ faraday-cli host create -d \\''[{\"ip\": \"stan.local\", \"description\": \"some server\"}]'\\'\n```\n\nOr pipe it\n```shell script\n$ echo '[{\"ip\": \"1.1.1.5\", \"description\": \"some text\"}]' | faraday-cli host create --stdin\n\n```\n**The escaping of the single quotes (\\\\') is only needed when using it as a command.\nIn the shell or using pipes it not necessary**\n\n\n### Import vulnerabilities from tool report\n\n```shell script\n$ faraday-cli tool report \"/path/to/report.xml\"\n```\n![Example](./docs/docs/images/process_report.gif)\n\n### Import vulnerabilities from command\n\n```shell script\n$ faraday-cli ping -c 1 www.google.com\n```\n![Example](./docs/docs/images/command.gif)\n\n### List agents\n\n```shell script\n$ faraday-cli agent list\n  id  name      active    status    executors\n----  --------  --------  --------  -----------\n   8  internal  True      online    nmap\n```\n\n### Run executor\n\n```shell script\n$ faraday-cli agent run -a 1 -e nmap -p \\''{\"target\": \"www.google.com\"}'\\'\nRun executor: internal/nmap [{'successful': True}]\n```\n\n\n\n## Use it like a shell\n\nFaraday-cli can be used as a shell and have all the same commands you have as a cli\n\n![Example](./docs/docs/images/shell.gif)\n\n## Use cases\n\n### Continuous scan your assets with faraday\n\nFor example run nmap for all the hosts in faraday that listen on the 443 port and import the results back to faraday\n```shell\n$ faraday-cli host list --port 443 -ip | nmap -iL - -oX /tmp/nmap.xml  \u0026\u0026 faraday-cli process_report /tmp/nmap.xml\n```\n\n### Scan your subdomains\n\nUse a tool like assetfinder to do a domains lookup, scan them with nmap and send de results to faraday\n\n```shell\n$ assetfinder -subs-only example.com| sort | uniq |awk 'BEGIN { ORS = \"\"; print \" {\\\"target\\\":\\\"\"}\n{ printf \"%s%s\", separator, $1, $2\nseparator = \",\"}END { print \"\\\"}\" }' | faraday-cli  agent run  -a 1 -e nmap --stdin\n```\n\n\n[doc]: https://docs.faraday-cli.faradaysec.com\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finfobyte%2Ffaraday-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finfobyte%2Ffaraday-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finfobyte%2Ffaraday-cli/lists"}