Skip to content
This repository was archived by the owner on Sep 9, 2022. It is now read-only.

Commit

Permalink
Merge branch 'scmn-dev:main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
abdfnx authored Nov 4, 2021
2 parents 3b1b3a6 + a89e8fd commit 2fba0f3
Show file tree
Hide file tree
Showing 41 changed files with 1,065 additions and 844 deletions.
24 changes: 12 additions & 12 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
* @abdfnx
README.md @Timothee-Cardoso @david-tomson
CHANGELOG.md @Timothee-Cardoso
Makefile @Timothee-Cardoso
/script/build.ps1 @Timothee-Cardoso
/core/core.go @Timothee-Cardoso @iMRxM7mD
secman.json @Timothee-Cardoso
.snyk @Timothee-Cardoso
.gitpod.yml @Timothee-Cardoso
/v1/README.md @Timothee-Cardoso @david-tomson
/v1/CHANGELOG.md @Timothee-Cardoso
/v1/Makefile @Timothee-Cardoso
/v1/script/build.ps1 @Timothee-Cardoso
/v1/core/core.go @Timothee-Cardoso @iMRxM7mD
/v1/secman.json @Timothee-Cardoso
/v1/.snyk @Timothee-Cardoso
/v1/.gitpod.yml @Timothee-Cardoso
.github/workflows/secman.yml @Timothee-Cardoso
/tools/constants/commands.go @Timothee-Cardoso
.editorconfig @Timothee-Cardoso
/core/schema.gql @david-tomson
.gitignore @iMRxM7mD
/v1/tools/constants/commands.go @Timothee-Cardoso
/v1/.editorconfig @Timothee-Cardoso
/v1/core/schema.gql @david-tomson
/v1/.gitignore @iMRxM7mD
30 changes: 30 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Release

on:
push:
tags:
- "v*.*.*"

jobs:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2

- uses: actions/[email protected]
with:
node-version: 14

- name: Install Dependencies
run: yarn

- name: Build
run: |
sudo yarn pack:deb
sudo mv ./dist/deb/secman_6.0.0-1_amd64.deb ./dist/deb/secman_v6.0.0_amd64.deb
- name: Upload It
uses: softprops/action-gh-release@v1
with:
files: ./dist/deb/secman_v6.0.0_amd64.deb
249 changes: 249 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,249 @@
# Secman CLI

<p align="center">
<img src="https://assets.secman.dev/assets/Secman.png" />
</p>

[![RELEASE](https://img.shields.io/github/v/release/scmn-dev/secman?style=flat-square)](https://github.com/scmn-dev/secman/releases/latest)

## Secman Products

- [**Secman Desktop**](https://d.secman.dev)
- [**Secman Extension**](https://secman.dev/extension)

## Code Status

[![CodeQL](https://img.shields.io/github/workflow/status/scmn-dev/secman/CodeQL?color=blue&label=CodeQL%20Build&logo=github&style=flat-square)](https://github.com/scmn-dev/secman/actions/workflows/codeql.yml)
[![Secman CI](https://img.shields.io/github/workflow/status/scmn-dev/secman/Secman%20CI?color=blue&label=Secman%20CI&logo=github-actions&logoColor=white&style=flat-square)](https://github.com/scmn-dev/secman/actions/workflows/secman.yml)
[![Secman Docker CI](https://img.shields.io/github/workflow/status/scmn-dev/secman/Secman%20Docker%20CI?color=blue&label=Secman%20Docker%20CI&logo=docker&style=flat-square)](https://github.com/scmn-dev/secman/actions/workflows/docker.yml)
[![Secman With GitPod](https://img.shields.io/badge/Gitpod-Ready%20to%20Code-blue?logo=gitpod&style=flat-square)](https://gitpod.io/#https://github.com/scmn-dev/secman)
![Codacy grade](https://img.shields.io/codacy/grade/c434720ddcc84bea982475063f903a81?color=blue&logo=codacy&style=flat-square)

> Open In [**VSCode**](https://code.visualstudio.com)
[![Open in Visual Studio Code](https://open.vscode.dev/badges/open-in-vscode.svg)](https://open.vscode.dev/scmn-dev/secman)

---

> `secman` is a password manager can store, retrieves, generates, and synchronizes passwords, and is written in _**TypeScript**_! The most important difference is secman is not GPG cored. Instead, it uses a master password to securely store your passwords. and you can easily manage your passwords from everywhere.
## Featurs

- **Not GPG cored**.
- **It uses a master password to securely store your passwords**.
- **It syncs your passwords**.
- **Easy to use**.
- **It is written in TypeScript**.
- **You can easily manage your passwords from everywhere, desktop, web, terminal, and more**.

## Examples

> Create a new password
```bash
secman new -l

✔ Title › Twitter
✔ URL › https://twitter.com
✔ Username › _secman
✔ Password › *********
✔ Extra › no extra

Password created
```

> List passwords
```bash
secman .

.
├──Logins
│ └──Twitter
├──Credit Cards
├──Emails
├──Notes
└──Servers
```

> Read It
```
secman read -l Twitter
╭─────────┬─────────────────────┬──────────────────┬───────────┬──────────╮
│ Title │ URL │ Username │ Password │ Extra │
├─────────┼─────────────────────┼──────────────────┼───────────┼──────────┤
│ Twitter │ https://twitter.com │ [email protected] │ ••••••••• │ no extra │
╰─────────┴─────────────────────┴──────────────────┴───────────┴──────────╯
```

#### show password

```bash
secman show -l -p Twitter

╭─────────┬─────────────────────┬──────────────────┬───────────┬──────────╮
│ Title │ URL │ Username │ Password │ Extra │
├─────────┼─────────────────────┼──────────────────┼───────────┼──────────┤
│ Twitter │ https://twitter.com │ [email protected] │ hitwitter │ no extra │
╰─────────┴─────────────────────┴──────────────────┴───────────┴──────────╯
```

> Edit password field
```bash
secman edit -l Twitter

? Pick a field › - Use arrow-keys. Return to submit.
❯ Title
URL
Username
Password
Extra
```

#### edit multiple fields

```code
secman edit -l -m Twitter
? Pick a field ›
? Pick a field ›
Instructions:
↑/↓: Highlight option
←/→/[space]: Toggle selection
a: Toggle all
enter/return: Complete answer
◯ Title
◉ URL
◯ Username
◯ Password
◉ Extra
```

## Installation ⬇

### Using npm

```bash
npm i -g secman
```

> (Windows): if you get an error you might need to change the **execution policy** _**(i.e. enable Powershell)**_ via
```powershell
Set-ExecutionPolicy RemoteSigned -scope CurrentUser
```

### Using [Homebrew](https://brew.sh) (macOS and Linux)

```bash
brew tap scmn-dev/secman
brew install secman
```

### Using script (Ubuntu/Debian)

```bash
curl -sL https://cli.secman.dev | bash
```

### Using SnapCraft

```bash
sudo snap install secman
```

### Via [Docker](https://docker.com)

> `secman cli` image
```bash
docker run -it smcr/secman-cli
```

see [**secman cli docs**](https://docker.secman.dev/docs/sm-cli)

> `secman container` image
```bash
docker run -it smcr/secman
```

see [**secman container docs**](https://docker.secman.dev/docs/sm-container)

## Build from source

see [**building from source**](https://docs.secman.dev/contributing/build_from_source) doc.

## Getting started with secman

> Initializing
```bash
secman init
```

> Authenticate
```bash
secman auth
```
>
> Insert a New Password
```bash
secman insert --[PASSWORD_TYPE]
```

> List Passwords
```bash
secman .
```

> Read The Password
```
secman read --[PASSWORD_TYPE] <PASSWORD_NAME>
```

> Edit Password
```bash
secman edit --[PASSWORD_TYPE] <PASSWORD_NAME>
```

> Generate
```bash
secman generate
```

> Edit Settings
```bash
secman settings
```

> see [commands](https://secman.dev/docs/cli)
## License

[secman][smurl] is licensed under the terms of [MIT][miturl] License

## Some Resources

- [**secman website**](https://secman.dev)
- [**docs**](https://secman.dev/docs)
- [**changelog**](https://secman.dev/changelog)

## Stargazers over time

[![Stargazers over time](https://starchart.cc/scmn-dev/secman.svg)](https://starchart.cc/scmn-dev/secman)

[smurl]: https://secman.dev
[miturl]: https://github.com/scmn-dev/secman/blob/main/LICENSE
5 changes: 1 addition & 4 deletions app/config/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@ import { writeJsonFile as writeJSON } from "../../tools/json/write";
import { homedir, platform } from "os";
import fs from "fs";
import path from "path";
// import * as chalk from "chalk";
const chalk = require("chalk");
import chalk from "chalk";

const secman_dir = path.join(homedir(), DOT_SECMAN_PATH);
const sm_config = path.join(homedir(), SECMAN_CONFIG_PATH);
Expand Down Expand Up @@ -94,8 +93,6 @@ export async function writeSettingFile() {
await writeJSON(
sm_setting,
{
read_output: "table",
disable_version_check: false,
editor: "secman_editor",
},
{}
Expand Down
Loading

0 comments on commit 2fba0f3

Please sign in to comment.