https://github.com/rpidanny/darwin

An elegant CLI wizard enhancing biotech research efficiency, with adaptable features for other domains, albeit with minor constraints.
https://github.com/rpidanny/darwin

bioinformatics biotech biotechnology darwin genomics google-scholar research research-paper

Last synced: 2 days ago
JSON representation

An elegant CLI wizard enhancing biotech research efficiency, with adaptable features for other domains, albeit with minor constraints.

• Host: GitHub
• URL: https://github.com/rpidanny/darwin
• Owner: rpidanny
• License: mit
• Created: 2024-05-31T19:06:13.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-10-12T06:26:46.000Z (3 months ago)
• Last Synced: 2024-12-29T14:29:34.964Z (7 days ago)
• Topics: bioinformatics, biotech, biotechnology, darwin, genomics, google-scholar, research, research-paper
• Language: TypeScript
• Homepage:
• Size: 4.22 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![alt text](darwin.png 'Darwin')

# Darwin

`Darwin` is an elegant and powerful command-line interface (CLI) utility designed to streamline your research efforts. While it shines brightest in the field of [biotechnology](https://en.wikipedia.org/wiki/Biotechnology), its versatile tools can support research across various domains, albeit with some limitations.

[![Version](https://img.shields.io/npm/v/@rpidanny/darwin.svg)](https://npmjs.org/package/@rpidanny/darwin)

[![Downloads/week](https://img.shields.io/npm/dw/@rpidanny/darwin.svg)](https://npmjs.org/package/@rpidanny/darwin)

* [Darwin](#darwin)

* [Usage](#usage)

* [Command Topics](#command-topics)

* [FAQ](#faq)

* [Use Cases](#use-cases)

* [Issues and Feature Requests](#issues-and-feature-requests)

* [Contribution](#contribution)

* [License](#license)

# Usage

## Prerequisites

- [Node.js v20+](https://nodejs.org/en/download/prebuilt-installer)

- [Ollama](https://ollama.com/) _(optional for paper summarization)_

- [OpenAI API Keys](https://platform.openai.com/settings/profile?tab=api-keys) _(optional for chat interface)_

```sh-session

$ npm install -g @rpidanny/darwin

$ darwin COMMAND

running command...

$ darwin (--version)

@rpidanny/darwin/1.35.1 linux-x64 node-v20.15.0

$ darwin --help [COMMAND]

USAGE

  $ darwin COMMAND

...

```

> After installing, configure Darwin with `darwin config set`.

# Command Topics

* [`darwin chat`](docs/chat.md) - Chat with Darwin using natural language.

* [`darwin config`](docs/config.md) - Manage application configurations.

* [`darwin download`](docs/download.md) - Download papers, datasets, or other content.

* [`darwin search`](docs/search.md) - Search for papers, accession numbers, or other content.

* [`darwin update`](docs/update.md) - Update Darwin to the latest version.

# FAQ

[Frequently Asked Questions](docs/faq.md)

# Use Cases

- [Use Cases](docs/use-cases.md)

# Issues and Feature Requests

If you encounter any issues or have a feature request, please [open an issue](https://github.com/rpidanny/darwin/issues) in the repository. We'd love to hear from you and improve Darwin together!

# Contribution

We welcome contributions to `Darwin`! To contribute, fork the repository, create a new branch for your feature, make your changes, and submit a pull request. For more details, see our [CONTRIBUTING](CONTRIBUTING.md) guidelines.

# License

`Darwin` is released under the MIT License. See the [LICENSE](LICENSE) file for more details.