tnote-cli


Nametnote-cli JSON
Version 0.0.6 PyPI version JSON
download
home_pagehttps://github.com/CarsonHenrich/tnote-cli
SummaryA simple Terminal-based notes app
upload_time2022-08-06 07:42:37
maintainer
docs_urlNone
authorCarson Henrich
requires_python
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # tnote-cli
A simple notes Command line tool, because I really got tired of either:

A. going from the terminal into another app to write something down for later
or 
B. Forgetting which configuration file is where and not having a convenient place where all my notes could be kept

Plus I really just wanted a project to work on.

## Installation 

```
pip install tnote-cli
```


## Usage 

Using tnote is pretty simple when it really comes down to it as there is only one command that has several options. 


#### Index

The index of all the notes you've created can be accessed by `$ tnote` with no arguments.
At any point you can use `$ tn` as it is the same because who has time for all those extra keystrokes.

```
$ tnote 
|-------------------------INDEX-------------------------|


|-------------------------RECENT------------------------|
 Note ID: todo
 Name: todo.md
 Path: /Users/username/.tnote/notes/todo.md
|-------------------------------------------------------|
    
            _________________________________
            

|-------------------------------------------------------|
 Note ID: todo
 Name: todo.md
 Path: /Users/username/.tnote/notes/todo.md
|-------------------------------------------------------|

```
At first your index obviously won't look like this but create a note and you'll be good.
Up at the top there it will show you want is your most recently edited note which can be accessed 
using the `$ -r` flag.

#### Creating and Editing Notes

To create a new note you need only type in a name for a note like so `$ tn EXAMPLE` and a note will be created and 
you'll begin editing it. You can also specify editing with the `$ -e` flag. The editor used will be the `$EDITOR` 
environment variable but it can also be changed in the config at `~/.tnote.json`

```
$ tnote -e Example
```

```
$ tn Example
```

#### View

Tnote was designed with using markdown in mind as it is how I frequently take notes as 
such if you wish to render it from your terminal use the view flag.
```
$ tnote -v Example
```

#### Moving and Renaming
If you wish to rename a file simply do so by passing the same path other than the filename to the move option:
```
$ tnote Example -m ~/tnote/notes/new_name.md 
```
otherwise just pass a fully qualified path with filename to move the file:
```
$ tnote Example -m ~/Example.md
```


#### Delete
To permenantly delete a note:
```
$ tnote -d Example
```


#### Change ID
IF you want to change the Id you use to access notes you do so as shown below 
``` 
$ tnote Example -i new-id
```
to access this note in the future you'll use `new-id`

#### Execute 

From time to time I like to have some simple scripts on-hand for quick access 
so I have allowed a way to simply execute from my notes 

Execute a file that has permissions:
```
tnote Script -x
```

Give a file permission (chmod) and execute it:
```
tnote Script -xx
```



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/CarsonHenrich/tnote-cli",
    "name": "tnote-cli",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Carson Henrich",
    "author_email": "contact@carsonhenrich.com",
    "download_url": "https://files.pythonhosted.org/packages/bf/43/620b650a208b13dd71f75e43535920d41004be19674f2662d970cb4ec350/tnote-cli-0.0.6.tar.gz",
    "platform": null,
    "description": "# tnote-cli\nA simple notes Command line tool, because I really got tired of either:\n\nA. going from the terminal into another app to write something down for later\nor \nB. Forgetting which configuration file is where and not having a convenient place where all my notes could be kept\n\nPlus I really just wanted a project to work on.\n\n## Installation \n\n```\npip install tnote-cli\n```\n\n\n## Usage \n\nUsing tnote is pretty simple when it really comes down to it as there is only one command that has several options. \n\n\n#### Index\n\nThe index of all the notes you've created can be accessed by `$ tnote` with no arguments.\nAt any point you can use `$ tn` as it is the same because who has time for all those extra keystrokes.\n\n```\n$ tnote \n|-------------------------INDEX-------------------------|\n\n\n|-------------------------RECENT------------------------|\n Note ID: todo\n Name: todo.md\n Path: /Users/username/.tnote/notes/todo.md\n|-------------------------------------------------------|\n    \n            _________________________________\n            \n\n|-------------------------------------------------------|\n Note ID: todo\n Name: todo.md\n Path: /Users/username/.tnote/notes/todo.md\n|-------------------------------------------------------|\n\n```\nAt first your index obviously won't look like this but create a note and you'll be good.\nUp at the top there it will show you want is your most recently edited note which can be accessed \nusing the `$ -r` flag.\n\n#### Creating and Editing Notes\n\nTo create a new note you need only type in a name for a note like so `$ tn EXAMPLE` and a note will be created and \nyou'll begin editing it. You can also specify editing with the `$ -e` flag. The editor used will be the `$EDITOR` \nenvironment variable but it can also be changed in the config at `~/.tnote.json`\n\n```\n$ tnote -e Example\n```\n\n```\n$ tn Example\n```\n\n#### View\n\nTnote was designed with using markdown in mind as it is how I frequently take notes as \nsuch if you wish to render it from your terminal use the view flag.\n```\n$ tnote -v Example\n```\n\n#### Moving and Renaming\nIf you wish to rename a file simply do so by passing the same path other than the filename to the move option:\n```\n$ tnote Example -m ~/tnote/notes/new_name.md \n```\notherwise just pass a fully qualified path with filename to move the file:\n```\n$ tnote Example -m ~/Example.md\n```\n\n\n#### Delete\nTo permenantly delete a note:\n```\n$ tnote -d Example\n```\n\n\n#### Change ID\nIF you want to change the Id you use to access notes you do so as shown below \n``` \n$ tnote Example -i new-id\n```\nto access this note in the future you'll use `new-id`\n\n#### Execute \n\nFrom time to time I like to have some simple scripts on-hand for quick access \nso I have allowed a way to simply execute from my notes \n\nExecute a file that has permissions:\n```\ntnote Script -x\n```\n\nGive a file permission (chmod) and execute it:\n```\ntnote Script -xx\n```\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A simple Terminal-based notes app",
    "version": "0.0.6",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "5f93e9e56f6d78d5d011c77db0934350",
                "sha256": "518ec2769bea603d8d680f79e7ca068a8c140b1ca48afda18ec9e5533116efa3"
            },
            "downloads": -1,
            "filename": "tnote-cli-0.0.6.tar.gz",
            "has_sig": false,
            "md5_digest": "5f93e9e56f6d78d5d011c77db0934350",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 7797,
            "upload_time": "2022-08-06T07:42:37",
            "upload_time_iso_8601": "2022-08-06T07:42:37.824868Z",
            "url": "https://files.pythonhosted.org/packages/bf/43/620b650a208b13dd71f75e43535920d41004be19674f2662d970cb4ec350/tnote-cli-0.0.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-08-06 07:42:37",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "CarsonHenrich",
    "github_project": "tnote-cli",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "tnote-cli"
}
        
Elapsed time: 0.46126s