Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/guitmz/capable
Interact with Capacities.io API from your terminal
https://github.com/guitmz/capable
Last synced: 3 days ago
JSON representation
Interact with Capacities.io API from your terminal
- Host: GitHub
- URL: https://github.com/guitmz/capable
- Owner: guitmz
- License: mit
- Created: 2024-08-30T12:29:47.000Z (2 months ago)
- Default Branch: master
- Last Pushed: 2024-09-17T07:49:16.000Z (about 2 months ago)
- Last Synced: 2024-09-17T10:21:21.749Z (about 2 months ago)
- Language: Go
- Homepage:
- Size: 20.5 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Capable
Interact with Capacities.io API from your terminal.
##### Table of Contents
- [ Overview](#-overview)
- [ Features](#-features)
- [ Getting Started](#-getting-started)
- [ Installation](#-installation)
- [ Usage](#-usage)
- [ Project Roadmap](#-project-roadmap)
- [ Contributing](#-contributing)
- [ License](#-license)
- [ Acknowledgments](#-acknowledgments)
---
## Overview
The CLI tool is designed to interact with the Capacities.io API, enabling users to send daily entries and weblinks to the Capacities platform directly from the command line. Capacities.io is a platform focused on personal knowledge management and note-taking, allowing users to create, organize, and connect information efficiently.
---
## Features
| | Feature | Description |
|----|-------------------|---------------------------------------------------------------|
| 📝 | **Daily Notes** | Append text to the daily note for the current date. This is useful for journaling or quickly adding thoughts. Supports inputs from the command line or `stdin` with Markdown formatting and automatic timestamping. |
| 🔗 | **Weblinks** | Add a weblink to Capacities from your command line. |
---
## Getting Started
### Requirements
Capable requires `CAPACITIES_SPACE_ID` and `CAPACITIES_API_TOKEN` environment variables to be defined for authentication. Please refer to the official documentation for more information.
### Installation
To install the binary run:
```sh
go install github.com/guitmz/capable@latest
```
Other installation options are the following:
- Download the pre-compiled binary from the releases page
- Use Homebrew `brew install guitmz/tools/capable`
- Or follow the guide below to build the project from source:
1. Clone the app repository:
```sh
❯ git clone https://github.com/guitmz/capable.git
```
2. Navigate to the project directory:
```sh
❯ cd capable
```
3. Install the required dependencies:
```sh
❯ go build -o capable
```
### Usage
To run the project, execute the following command:
```sh
❯ ./capable
```
---
## Project Roadmap
- [X] **`Weblinks`**: Implement sending weblinks.
- [X] **`Daily Notes`**: Implement adding to daily notes.
- [ ] **`Search`**: Implement search feature.
---
## Contributing
Contributions are welcome! Please submit a pull request or open an issue, clearly describing the changes and their motivations.
---
## License
This project is protected under the [MIT](https://choosealicense.com/licenses/mit/) License.
---
## Acknowledgments
- [Capacities.io API documentation](https://docs.capacities.io/developer/api)
- [Capacities.io API reference](https://api.capacities.io/docs/)
---