https://github.com/codedge-llc/pane

Paginated viewer for IEx
https://github.com/codedge-llc/pane

elixir iex

Last synced: 10 months ago
JSON representation

Paginated viewer for IEx

• Host: GitHub
• URL: https://github.com/codedge-llc/pane
• Owner: codedge-llc
• License: mit
• Created: 2017-02-26T22:20:44.000Z (almost 9 years ago)
• Default Branch: main
• Last Pushed: 2025-03-15T13:52:48.000Z (11 months ago)
• Last Synced: 2025-03-15T14:33:43.243Z (11 months ago)
• Topics: elixir, iex
• Language: Elixir
• Homepage: https://hex.pm/packages/pane
• Size: 133 KB
• Stars: 14
• Watchers: 4
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# Pane

> Paginated data viewer for IEx. Written for [scribe](https://github.com/codedge-llc/scribe).

> Useful for inspecting large collections and deeply nested structs.

[![CI](https://github.com/codedge-llc/pane/actions/workflows/ci.yml/badge.svg)](https://github.com/codedge-llc/pane/actions/workflows/ci.yml)

[![Version](https://img.shields.io/hexpm/v/pane.svg)](https://hex.pm/packages/pane)

[![Total Downloads](https://img.shields.io/hexpm/dt/pane.svg)](https://hex.pm/packages/pane)

[![License](https://img.shields.io/hexpm/l/pane.svg)](https://github.com/codedge-llc/pane/blob/main/LICENSE.md)

[![Last Updated](https://img.shields.io/github/last-commit/codedge-llc/pane.svg)](https://github.com/codedge-llc/pane/commits/main)

[![Documentation](https://img.shields.io/badge/documentation-gray)](https://hexdocs.pm/pane/)

## Installation

Add `:pane` as a `mix.exs` dependency:

```elixir

def deps do

  [

    {:pane, "~> 0.5.0"}

  ]

end

```

## Usage

    iex> data =  File.read!("mix.exs") # Or some other really long string

    iex> Pane.console(data)

![console](https://raw.githubusercontent.com/codedge-llc/pane/main/docs/console.png)

## Available Commands

- `j` - Next page

- `k` - Previous page

- `f` - First page

- `l` - Last page

- `q` - Quit

## Contributing

### Testing

Unit tests can be run with `mix test` or `mix coveralls.html`.

### Formatting

This project uses Elixir's `mix format` and [Prettier](https://prettier.io) for formatting.

Add hooks in your editor of choice to run it after a save. Be sure it respects this project's

`.formatter.exs`.

### Commits

Git commit subjects use the [Karma style](http://karma-runner.github.io/5.0/dev/git-commit-msg.html).

## License

Copyright (c) 2017-2025 Codedge LLC (https://www.codedge.io/)

This library is MIT licensed. See the [LICENSE](https://github.com/codedge-llc/pane/blob/main/LICENSE.md) for details.