Skip to content
/ capable Public

Interact with Capacities.io API from your terminal

License

Notifications You must be signed in to change notification settings

guitmz/capable

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Capable

Interact with Capacities.io API from your terminal.

GitHub%20Actions Go Go%20Report%20Card


Table of Contents

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:

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:
❯ git clone https://github.com/guitmz/capable.git
  1. Navigate to the project directory:
cd capable
  1. Install the required dependencies:
❯ go build -o capable

Usage

To run the project, execute the following command:

❯ ./capable

Project Roadmap

  • Weblinks: Implement sending weblinks.
  • 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 License.

Acknowledgments


About

Interact with Capacities.io API from your terminal

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages