ink

What is ink?

Ink is a React-based framework for building command-line interface (CLI) applications. It allows developers to use React components to create interactive and dynamic CLI tools.

What are ink's main functionalities?

Rendering Text

Ink allows you to render text in the terminal using React components. The example demonstrates a simple 'Hello, world!' text rendering.

const { render, Text } = require('ink');

const App = () => <Text>Hello, world!</Text>;

render(<App />);

Handling User Input

Ink provides hooks like `useInput` to handle user input. This example shows how to exit the application when the user presses 'q'.

const { render, Text, useInput } = require('ink');

const App = () => {
  useInput((input, key) => {
    if (input === 'q') {
      process.exit();
    }
  });

  return <Text>Press 'q' to exit.</Text>;
};

render(<App />);

Using Components

Ink supports layout components like `Box` to arrange other components. This example demonstrates a vertical layout with two text components.

const { render, Box, Text } = require('ink');

const App = () => (
  <Box flexDirection="column">
    <Text>Hello</Text>
    <Text>World</Text>
  </Box>
);

render(<App />);

Styling Text

Ink allows you to style text using properties like `color`. This example shows how to render green-colored text.

const { render, Text } = require('ink');

const App = () => (
  <Text color="green">This is green text</Text>
);

render(<App />);

Other packages similar to ink

blessed

Blessed is a library for creating interactive command-line applications. It provides a wide range of widgets and supports mouse and keyboard input. Compared to Ink, Blessed is more low-level and imperative, whereas Ink leverages React's declarative approach.

ink-select-input

Ink-select-input is a component for Ink that allows you to create interactive select inputs. It is specifically designed to work with Ink, providing a higher-level abstraction for creating selection menus. Unlike Ink, which is a full framework, ink-select-input is a specialized component.

vorpal

Vorpal is a framework for building interactive CLI applications. It provides a command-line interface with built-in help, tab completion, and more. Vorpal is more focused on creating command-based interfaces, whereas Ink is more flexible and component-based.

README

Ink

Ink is a tool for automating the process of incrementing version numbers, which becomes especially tedious when you have multiple manifest files to maintain for different package managers.

Install

[sudo] npm install -g ink

Use

Run ink from the same directory as your manifests.

To-do

• More manifest types
• Automatically update CHANGELOG.md with an entry for the new version and open it in a text editor.
  • Use Git commit messages to auto-populate with changes?

License

MIT