https://github.com/matteopolak/cyberrange

An unofficial API wrapper for FieldEffect CyberRange.
https://github.com/matteopolak/cyberrange

api api-wrapper cyberrange cybersecurity fieldeffect

Last synced: 25 days ago
JSON representation

An unofficial API wrapper for FieldEffect CyberRange.

• Host: GitHub
• URL: https://github.com/matteopolak/cyberrange
• Owner: matteopolak
• License: mit
• Created: 2022-05-12T22:23:46.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-05-20T22:30:53.000Z (about 3 years ago)
• Last Synced: 2025-02-16T18:46:32.373Z (4 months ago)
• Topics: api, api-wrapper, cyberrange, cybersecurity, fieldeffect
• Language: TypeScript
• Homepage:
• Size: 108 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
## CyberRange

![Build Status](https://github.com/matteopolak/cyberrange/actions/workflows/check.yml/badge.svg)

An unofficial API wrapper for [CyberRange](https://ictc-cyberrange.fieldeffect.net).

### Features

- Includes wrapper for administrator API

- TypeScript support

### Requirements

- Node.js 16.0.0+

### Example usage

```typescript

import { User } from 'cyberrange';

// Create a new user

const user = new User('username', 'password');

// Authenticate the user

await user.login();

// Print out all active and expired campaigns (courses)

console.log(

	await user.campaigns(),

);

```