{"id":13400596,"url":"https://github.com/Velocidex/velociraptor","last_synced_at":"2025-03-14T06:31:45.015Z","repository":{"id":37255256,"uuid":"126576769","full_name":"Velocidex/velociraptor","owner":"Velocidex","description":"Digging Deeper....","archived":false,"fork":false,"pushed_at":"2024-04-12T17:09:00.000Z","size":45806,"stargazers_count":2635,"open_issues_count":85,"forks_count":444,"subscribers_count":70,"default_branch":"master","last_synced_at":"2024-04-13T09:07:53.134Z","etag":null,"topics":["digital-forensics","endpoint-discovery","endpoint-protection","endpoint-security","forensics-investigations","incident-response","inventory-management"],"latest_commit_sha":null,"homepage":"https://docs.velociraptor.app/","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Velocidex.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":"security.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2018-03-24T07:39:32.000Z","updated_at":"2024-04-14T18:44:09.829Z","dependencies_parsed_at":"2023-10-03T21:48:40.160Z","dependency_job_id":"891151b2-172b-4ccc-bb4c-0c418325c410","html_url":"https://github.com/Velocidex/velociraptor","commit_stats":{"total_commits":1898,"total_committers":79,"mean_commits":"24.025316455696203","dds":"0.40990516332982085","last_synced_commit":"4a1df830842c1dbce31b4e4afd8649ffc86f0d15"},"previous_names":[],"tags_count":77,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Velocidex%2Fvelociraptor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Velocidex%2Fvelociraptor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Velocidex%2Fvelociraptor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Velocidex%2Fvelociraptor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Velocidex","download_url":"https://codeload.github.com/Velocidex/velociraptor/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221440198,"owners_count":16821600,"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":["digital-forensics","endpoint-discovery","endpoint-protection","endpoint-security","forensics-investigations","incident-response","inventory-management"],"created_at":"2024-07-30T19:00:53.726Z","updated_at":"2025-03-14T06:31:45.002Z","avatar_url":"https://github.com/Velocidex.png","language":"Go","funding_links":[],"categories":["Go","Threat Detection and Hunting","IR Tools Collection","Projects","Challenges","Tools","others","Other Lists","Uncategorized","***BIOS UEFI***","Blue Team","Defensive (D3FEND-aligned lifecycle)","前端开发框架及项目"],"sub_categories":["Tools","All-In-One Tools","Incident Response","Acquisition","🛡️ DFIR:","Uncategorized","***Vulnerabilities***","Forensics","🚨 Incident Response","Vue工具库"],"readme":"# Velociraptor - Endpoint visibility and collection tool.\n\nVelociraptor is a tool for collecting host based state information\nusing The Velociraptor Query Language (VQL) queries.\n\nTo learn more about Velociraptor, read the documentation on:\n\nhttps://docs.velociraptor.app/\n\n## Quick start\n\nIf you want to see what Velociraptor is all about simply:\n\n1. Download the binary from the release page for your favorite platform (Windows/Linux/MacOS).\n\n2. Start the GUI\n\n```bash\n  $ velociraptor gui\n```\n\nThis will bring up the GUI, Frontend and a local client. You can\ncollect artifacts from the client (which is just running on your own\nmachine) as normal.\n\nOnce you are ready for a full deployment, check out the various deployment options at\nhttps://docs.velociraptor.app/docs/deployment/\n\n## Training\n\nWe have our complete training course (7 sessions x 2 hours each)\nhttps://docs.velociraptor.app/training/\n\nThe course covers many aspects of Velociraptor in detail.\n\n## Running Velociraptor via Docker\n\nTo run a Velociraptor server via Docker, follow the instructions here:\nhttps://github.com/weslambert/velociraptor-docker\n\n## Running Velociraptor locally\n\nVelociraptor is also useful as a local triage tool. You can create a self contained local collector using the GUI:\n\n1. Start the GUI as above (`velociraptor gui`).\n\n2. Select the `Server Artifacts` sidebar menu, then `Build Collector`.\n\n3. Select and configure the artifacts you want to collect, then select\n   the `Uploaded Files` tab and download your customized collector.\n\n## Building from source\n\nTo build from source, make sure you have:\n - a recent Golang installed from https://golang.org/dl/ (Currently at least Go 1.23.2)\n   - the `go` binary is in your path.\n   - the `GOBIN` directory is in your path (defaults on linux and mac to `~/go/bin`, on\nWindows `%USERPROFILE%\\\\go\\\\bin`).\n - `gcc` in your path for CGO usage (on Windows, [TDM-GCC](https://jmeubank.github.io/tdm-gcc/about/) has been verified to work)\n - `make`\n - Node.js LTS (the GUI is build using [Node v18.14.2](https://nodejs.org/en/blog/release/v18.14.2))\n\n```bash\n    $ git clone https://github.com/Velocidex/velociraptor.git\n    $ cd velociraptor\n\n    # This will build the GUI elements. You will need to have node\n    # installed first. For example get it from\n    # https://nodejs.org/en/download/.\n    $ cd gui/velociraptor/\n    $ npm install\n\n    # This will build the webpack bundle\n    $ make build\n\n    # To build a dev binary just run make.\n    # NOTE: Make sure ~/go/bin is on your path -\n    # this is required to find the Golang tools we need.\n    $ cd ../..\n    $ make\n\n    # To build production binaries\n    $ make linux\n    $ make windows\n```\n\nIn order to build Windows binaries on Linux you need the mingw\ntools. On Ubuntu this is simply:\n```bash\n$ sudo apt-get install mingw-w64-x86-64-dev gcc-mingw-w64-x86-64 gcc-mingw-w64\n```\n\n## Getting the latest version\n\nWe have a pretty frequent release schedule but if you see a new\nfeature submitted that you are really interested in, we would love to\nhave more testing prior to the official release.\n\nWe have a CI pipeline managed by GitHub actions. You can see the\npipeline by clicking the actions tab on our GitHub project. There are\ntwo workflows:\n\n1. Windows Test: this workflow builds a minimal version of the\n   Velociraptor binary (without the GUI) and runs all the tests on\n   it. We also test various windows support functions in this\n   pipeline. This pipeline builds on every push in each PR.\n\n2. Linux Build All Arches: This pipeline builds complete binaries for\n   many supported architectures. It only runs when the PR is merged\n   into the master branch. To download the latest binaries simply\n   select the latest run of this pipeline, scroll down the page to the\n   \"Artifacts\" section and download the *Binaries.zip* file (Note you\n   need to be logged into GitHub to see this).\n\nIf you fork the project on GitHub, the pipelines will run on your own\nfork as well as long as you enable GitHub Actions on your fork. If you\nneed to prepare a PR for a new feature or modify an existing feature\nyou can use this to build your own binaries for testing on all\narchitectures before send us the PR.\n\n## Supported platforms\n\nVelociraptor is written in Golang and so is available for all the\nplatforms [supported by Go](https://github.com/golang/go/wiki/MinimumRequirements).\nThis means that Windows XP and Windows server 2003 are **not**\nsupported but anything after Windows 7/Vista is.\n\nWe build our releases using the MUSL library (x64) for Linux and a\nrecent MacOS system, so earlier platforms may not be supported by our\nrelease pipeline. We also distribute 32 bit binaries for Windows but\nnot for Linux. If you need 32 bit Linux builds you will need to build\nfrom source. You can do this easily by forking the project on GitHub,\nenabling GitHub Actions in your fork and editing the `Linux Build All\nArches` pipeline.\n\n## Artifact Exchange\n\nVelociraptor's power comes from `VQL Artifacts`, that define many\ncapabilities to collect many types of data from endpoints.\nVelociraptor comes with many built in `Artifacts` for the most common\nuse cases. The community also maintains a large number of additional\nartifacts through the [Artifact Exchange](https://docs.velociraptor.app/exchange/).\n\n## Knowledge Base\n\nIf you need help performing a task such as deployment, VQL queries\netc. Your first port of call should be the Velociraptor Knowledge Base\nat https://docs.velociraptor.app/knowledge_base/ where you will find\nhelpful tips and hints.\n\n## Getting help\n\nQuestions and feedback are welcome at\nvelociraptor-discuss@googlegroups.com (or\nhttps://groups.google.com/g/velociraptor-discuss)\n\nYou can also chat with us directly on discord https://docs.velociraptor.app/discord\n\nFile issues on https://github.com/Velocidex/velociraptor\n\nRead more about Velociraptor on our blog:\nhttps://docs.velociraptor.app/blog/\n\nHang out on Medium https://medium.com/velociraptor-ir\n\nFollow us on Twitter [@velocidex](https://twitter.com/velocidex)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FVelocidex%2Fvelociraptor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FVelocidex%2Fvelociraptor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FVelocidex%2Fvelociraptor/lists"}