# ztrace

> strace for node

Latest version **1.0.0** (published 2016-11-01) · GPL-3.0+ license · 0 weekly downloads

## Install

```sh
npm install ztrace
pnpm add ztrace
yarn add ztrace
bun add ztrace
```

Provides the command `ztrace`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2016-11-01 |
| First published | 2016-10-31 |
| Weekly downloads | 0 |
| License | GPL-3.0+ |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Anna Henningsen |
| Maintainers | addaleax |
| Keywords | strace, trace, ztrace |

## Links

- npm: https://www.npmjs.com/package/ztrace
- Repository: https://github.com/addaleax/ztrace
- Homepage: https://github.com/addaleax/ztrace#readme
- Issues: https://github.com/addaleax/ztrace/issues
- npm.io page: https://npm.io/package/ztrace

## Dependencies (4)

- [chalk](https://npm.io/package/chalk.md) ^1.1.3
- [which](https://npm.io/package/which.md) ^1.2.8
- [yargs](https://npm.io/package/yargs.md) ^6.3.0
- [arrify](https://npm.io/package/arrify.md) ^1.0.1

## Recent versions

- 1.0.0 (latest) — 2016-11-01
- 1.0.0-beta2 (next) — 2016-10-31
- 1.0.0-beta1 — 2016-10-31

## README

ztrace
======

[![NPM Version](https://img.shields.io/npm/v/ztrace.svg?style=flat)](https://npmjs.org/package/ztrace)
[![Build Status](https://travis-ci.org/addaleax/ztrace.svg?style=flat&branch=master)](https://travis-ci.org/addaleax/ztrace?branch=master)
[![Coverage Status](https://coveralls.io/repos/addaleax/ztrace/badge.svg?branch=master)](https://coveralls.io/r/addaleax/ztrace?branch=master)

Trace what your program does, inspired by `strace(1)`.

Install:
`[sudo] npm install -g ztrace`

Usage:

`test.js`:
```js
const fs = require('fs');

fs.statSync('/');
```

Look at the `fs.stat` call in action:

```sh
$ ztrace -e fs.stat* -s unlimited ./test.js
fs.statSync('/')
 @fs.stat('/') = { dev: 2049, mode: 16877, nlink: 25, uid: 0, gid: 0, rdev: 0, blksize: 4096, ino: 2, size: 4096, blocks: 8, atime: 2016-10-31T08:45:52.988Z, mtime: 2016-10-23T16:04:32.775Z, ctime: 2016-10-23T16:04:32.775Z, birthtime: 2016-10-23T16:04:32.775Z }
-> { dev: 2049, mode: 16877, nlink: 25, uid: 0, gid: 0, rdev: 0, blksize: 4096, ino: 2, size: 4096, blocks: 8, atime: 2016-10-31T08:45:52.988Z, mtime: 2016-10-23T16:04:32.775Z, ctime: 2016-10-23T16:04:32.775Z, birthtime: 2016-10-23T16:04:32.775Z }
```

(`@fs.stat` is the call to the C++ layer itself.)

If you want to trace everything, you can do that using just `ztrace ./test.js`
– but be warned: This is still *very* slow.

There are shortcuts for programatically tracing interactions single objects
to stderr:

```js
const ztrace = require('ztrace');

// Displays results of this call to stderr.
ztrace(fs).statSync('.');

// Output:
// ~.statSync('.') = { dev: 44, mode: 16893, nlink:....377Z }
```

License
=======

<details>

<summary>GPL-3.0+, at least for now.</summary>

Copyright (C) 2016 Anna Henningsen

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

</details>

---
_Source: https://npm.io/package/ztrace · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._