bitburner-src/markdown/bitburner.ns.nuke.md
Snarling 65cd14e33b
DOC: Add ns documentation for possible sleeve tasks (#217)
* Add specific types for sleeve tasks
* Moved LocationName enum to overall enums file
* Add LocationName enum to those provided to player
* remove trailing s on CompanyPosNames enum (now CompanyPosName, in line with LocationName)
* Also regenerated all ns documentation. This leads to an expected error when checking for generated files, because PRs should not normally touch markdown files. Also leads to a lint failure in generated file bitburner.d.ts
* also removed some exporting from NetscriptDefinitions.d.ts for anything that wasn't imported somewhere else.
2022-11-20 12:07:22 -05:00

47 lines
757 B
Markdown

<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [NS](./bitburner.ns.md) &gt; [nuke](./bitburner.ns.nuke.md)
## NS.nuke() method
Runs NUKE.exe on a server.
<b>Signature:</b>
```typescript
nuke(host: string): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| host | string | Hostname of the target server. |
<b>Returns:</b>
void
## Remarks
RAM cost: 0.05 GB
Running NUKE.exe on a target server gives you root access which means you can execute scripts on said server. NUKE.exe must exist on your home computer.
## Example 1
```ts
// NS1:
nuke("foodnstuff");
```
## Example 2
```ts
// NS2:
ns.nuke("foodnstuff");
```