Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![npm version](https://badge.fury.io/js/@kintone%2Fcli.svg)](https://badge.fury.io/js/@kintone%2Fcli)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)

A CLI tool to import/export records to/from [Kintone](https://www.kintone.com/).
The command line interface for [Kintone](https://www.kintone.com/).

## Documentation

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"name": "Cybozu, Inc.",
"url": "https://cybozu.co.jp"
},
"description": "cli-kintone; The CLI tool for importing and exporting Kintone records.",
"description": "The command line interface for Kintone",
"bin": {
"cli-kintone": "cli.js"
},
Expand Down
17 changes: 12 additions & 5 deletions website/docs/guide/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,18 @@ There are better tutorials for Japanese speakers.

## What is cli-kintone?

cli-kintone is the CLI tool for importing and exporting [Kintone](https://www.kintone.com/en-us/) records. It is suitable for batch record operations.

- Backup/restore Kintone records
- Data synchronization between Kintone and other BI platforms
- Data migration from other systems
cli-kintone is the CLI tool for Kintone customization and data management.

- **Record operations** — Import, export, and delete Kintone records in batch
- Backup/restore Kintone records
- Data synchronization between Kintone and other BI platforms
- Data migration from other systems
- **Plugin development** — Initialize, package, and upload Kintone plugins
- Scaffold a new plugin project from templates
- Package and deploy plugins to your Kintone environment
- **JavaScript/CSS customization** — Manage app customization files
- Apply JavaScript/CSS customization to Kintone apps
- Export existing customization settings for version control

:::tip[Pronunciation]
cli-kintone is pronounced "Koo-Ree Kint-Own," and "Kint" rhymes with "hint." It is named after the Japanese sweet [栗きんとん](https://visitgifu.com/see-do/kurikinton/).
Expand Down
2 changes: 1 addition & 1 deletion website/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import type * as Preset from "@docusaurus/preset-classic";

const config: Config = {
title: "cli-kintone",
tagline: "The CLI tool for importing and exporting Kintone records.",
tagline: "The command line interface for Kintone",
favicon: "img/cli-kintone_logo.svg",

// Set the production url of your site here
Expand Down
14 changes: 7 additions & 7 deletions website/i18n/ja/code.json
Original file line number Diff line number Diff line change
Expand Up @@ -558,15 +558,15 @@
"description": "The title of the tag list page"
},
"homepage.tagline": {
"message": "Kintone レコードをインポート・エクスポートするCLIツール",
"message": "kintone のコマンドラインインターフェース",
"description": "The homepage tagline"
},
"homepage.getStarted": {
"message": "はじめる",
"description": "The get started button label"
},
"homepage.description": {
"message": "Kintone レコードをインポート・エクスポートするCLIツール",
"message": "kintone のコマンドラインインターフェース",
"description": "The homepage meta description"
},
"homepage.features.easyToUse.title": {
Expand All @@ -575,11 +575,11 @@
"homepage.features.easyToUse.description": {
"message": "cli-kintone はIT担当者やエンジニア以外の方でも使えるように設計されています。すぐに慣れることができます。"
},
"homepage.features.attachmentSupport.title": {
"message": "添付ファイルフィールド対応"
"homepage.features.allInOne.title": {
"message": "オールインワン kintone CLI"
},
"homepage.features.attachmentSupport.description": {
"message": "cli-kintone は添付ファイルフィールドに対応しています。Kintone レコードと一緒にファイルをダウンロードまたはアップロードできます。"
"homepage.features.allInOne.description": {
"message": "レコード操作、プラグイン開発、JavaScript/CSS カスタマイズ — すべてを1つのツールで。"
},
"homepage.features.automation.title": {
"message": "自動化に最適"
Expand All @@ -588,7 +588,7 @@
"message": "cli-kintone はシェルスクリプトとの連携に優れています。定期的な作業や日常業務を自動化できます。"
},
"homepage.title": {
"message": "cli-kintone; Kintone レコードをインポート・エクスポートするCLIツール",
"message": "cli-kintone - kintone のコマンドラインインターフェース",
"description": "The homepage title"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,18 @@ import TabItem from '@theme/TabItem';

## cli-kintoneとは?

cli-kintoneは、[kintone](https://kintone.cybozu.co.jp/)のレコードをインポート・エクスポートするためのCLIツールです。バッチ処理によるレコード操作に適しています。

- Kintoneレコードのバックアップ/リストア
- KintoneとBIプラットフォーム間のデータ同期
- 他システムからのデータ移行
cli-kintoneは、kintone のカスタマイズとデータ管理のためのCLIツールです。

- **レコード操作** — kintone レコードの一括インポート、エクスポート、削除
- kintone レコードのバックアップ/リストア
- kintone と BI プラットフォーム間のデータ同期
- 他システムからのデータ移行
- **プラグイン開発** — kintone プラグインの初期化、パッケージング、アップロード
- テンプレートから新しいプラグインプロジェクトを作成
- プラグインをパッケージ化して kintone 環境にデプロイ
- **JavaScript/CSS カスタマイズ** — アプリカスタマイズファイルの管理
- kintone アプリに JavaScript/CSS カスタマイズを適用
- 既存のカスタマイズ設定をバージョン管理用にエクスポート

:::tip[発音]
cli-kintoneは「クリキントーン」と発音します。名前は日本の和菓子[栗きんとん](https://visitgifu.com/see-do/kurikinton/)に由来しています。
Expand Down Expand Up @@ -103,14 +110,14 @@ cli-kintoneを実行するには、APIアクセスが可能なkintoneの契約

### 設定

cli-kintoneからKintoneにアクセスするには、認証情報を設定する必要があります。
cli-kintoneからkintoneにアクセスするには、認証情報を設定する必要があります。
繰り返しを減らすため、環境変数を設定することをお勧めします。

設定する環境変数は以下の通りです。

|キー|説明|
|-|-|
|`KINTONE_BASE_URL`|アクセスしたいKintoneのベースURL。<br/>例:`https://example.cybozu.com`|
|`KINTONE_BASE_URL`|アクセスしたいkintoneのベースURL。<br/>例:`https://example.cybozu.com`|
|`KINTONE_API_TOKEN`|アクセスしたいアプリのAPIトークン|

:::tip
Expand Down Expand Up @@ -140,7 +147,7 @@ cli-kintoneからKintoneにアクセスするには、認証情報を設定す

### レコードのエクスポート

それでは始めましょう。`record export`コマンドを使用してKintoneアプリからレコードを取得します
それでは始めましょう。`record export`コマンドを使用してkintoneアプリからレコードを取得します

<Tabs>
<TabItem value="linux-macos" label="Linux/macOS" default>
Expand Down
12 changes: 6 additions & 6 deletions website/src/components/HomepageFeatures/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ const FeatureList: FeatureItem[] = [
},
{
title: (
<Translate id="homepage.features.attachmentSupport.title">
Attachment field support
<Translate id="homepage.features.allInOne.title">
All-in-one Kintone CLI
</Translate>
),
Svg: require("@site/static/img/undraw_add_files_re_v09g.svg").default,
Svg: require("@site/static/img/undraw_data_at_work.svg").default,
description: (
<Translate id="homepage.features.attachmentSupport.description">
The cli-kintone supports Attachment fields. You can download or upload
files among with Kintone records.
<Translate id="homepage.features.allInOne.description">
Manage records, develop plugins, and apply JavaScript/CSS customization
— all from a single tool.
</Translate>
),
},
Expand Down
7 changes: 3 additions & 4 deletions website/src/pages/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ const HomepageHeader = () => {
</Heading>
<p className="hero__subtitle">
<Translate id="homepage.tagline" description="The homepage tagline">
The CLI tool for importing and exporting Kintone records.
The command line interface for Kintone
</Translate>
</p>
<div className={styles.buttons}>
Expand All @@ -42,13 +42,12 @@ const Home = (): JSX.Element => {
<Layout
title={translate({
id: "homepage.title",
message:
"cli-kintone; The CLI tool for importing and exporting Kintone records.",
message: "cli-kintone - The command line interface for Kintone",
description: "The homepage title",
})}
description={translate({
id: "homepage.description",
message: "The CLI tool for importing and exporting Kintone records.",
message: "The command line interface for Kintone",
description: "The homepage meta description",
})}
>
Expand Down
Loading
Loading