{"id":16265119,"url":"https://github.com/apocas/firecrackerode","last_synced_at":"2025-09-18T15:33:08.367Z","repository":{"id":42896322,"uuid":"252323082","full_name":"apocas/firecrackerode","owner":"apocas","description":"Firecracker + Node = Firecrackerode (Node.js module for Amazon's Firecracker MicroVM platform)","archived":false,"fork":false,"pushed_at":"2025-01-03T22:57:50.000Z","size":13996,"stargazers_count":26,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-08T01:27:24.683Z","etag":null,"topics":["amazon","amazon-firecracker","firecracker","javascript","node","nodejs"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apocas.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":"2020-04-02T01:09:31.000Z","updated_at":"2025-01-03T22:57:54.000Z","dependencies_parsed_at":"2023-01-31T15:30:59.355Z","dependency_job_id":null,"html_url":"https://github.com/apocas/firecrackerode","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/apocas%2Ffirecrackerode","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apocas%2Ffirecrackerode/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apocas%2Ffirecrackerode/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apocas%2Ffirecrackerode/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apocas","download_url":"https://codeload.github.com/apocas/firecrackerode/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":233496523,"owners_count":18684942,"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":["amazon","amazon-firecracker","firecracker","javascript","node","nodejs"],"created_at":"2024-10-10T17:06:24.968Z","updated_at":"2025-09-18T15:33:00.250Z","avatar_url":"https://github.com/apocas.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# firecrackerode\n\nNode.js client for Amazon's [Firecracker](http://firecracker-microvm.io) MicroVM platform.\n\n## Installation\n\n`npm install firecrackerode`\n\n## Usage\n\n * Check [Fireracker API documentation](https://github.com/firecracker-microvm/firecracker/blob/main/src/firecracker/swagger/firecracker.yaml) for more details.\n \n\n### Getting started\n\nTo use `firecrackerode` first you need to instantiate it:\n\n``` js\nvar Firecracker = require('firecrackerode');\nvar firecracker = new Firecracker({socketPath: '/tmp/firecracker.socket'});\n```\n\n### Creating a MicroVM\n\n``` js\n//https://s3.amazonaws.com/spec.ccfc.min/img/hello/kernel/hello-vmlinux.bin\nfirecracker.bootSource({\n  'kernel_image_path': process.cwd() + '/images/hello-vmlinux.bin',\n  'boot_args': 'console=ttyS0 reboot=k panic=1 pci=off'\n}).then(function(data) {\n  //https://s3.amazonaws.com/spec.ccfc.min/img/hello/fsfiles/hello-rootfs.ext4\n  var drive = firecracker.drive('rootfs');\n  return drive.updatePreboot({\n    'path_on_host': process.cwd() + '/images/hello-rootfs.ext4',\n    'is_root_device': true,\n    'is_read_only': false\n  });\n}).then(function(data) {\n  return firecracker.action('InstanceStart');\n}).then(function(data){\n  console.log('MicroVM booted!');\n}).catch(function(err) {\n  console.log(err);\n});\n```\n\n### Helper functions\n\n``` js\n//Downloading an image\nfirecracker.downloadImage('https://s3.amazonaws.com/spec.ccfc.min/img/hello/kernel/hello-vmlinux.bin', os.tmpdir() + '/hello-vmlinux.bin').then(function () {\n  console.log('Kernel image downloaded!');\n}).catch(function(err) {\n  console.log(err);\n});\n\n//Spawn Firecracker process\nfirecracker.spawn().then(function () {\n  console.log('Firecracker spawned!');\n}).catch(function(err) {\n  console.log(err);\n});\n\n//Kill Firecracker process\nfirecracker.kill()\n\n```\n\n## Tests\n\n * You need a KVM host.\n * Tests are implemented using `mocha` and `chai`. Run them with `npm test`.\n\n## Examples\n\nCheck the examples folder for more specific use cases examples.\n\n## License\n\nPedro Dias - [@pedromdias](https://twitter.com/pedromdias)\n\nLicensed under the Apache license, version 2.0 (the \"license\"); You may not use this file except in compliance with the license. You may obtain a copy of the license at:\n\n    http://www.apache.org/licenses/LICENSE-2.0.html\n\nUnless required by applicable law or agreed to in writing, software distributed under the license is distributed on an \"as is\" basis, without warranties or conditions of any kind, either express or implied. See the license for the specific language governing permissions and limitations under the license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapocas%2Ffirecrackerode","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapocas%2Ffirecrackerode","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapocas%2Ffirecrackerode/lists"}